Management API reference

The Knock management API provides you with a programmatic way to interact with the resources you create and manage in your Knock dashboard, including workflows, templates, layouts, translations and commits. It's separate from the Knock API and only provides access to a limited subset of resources.

You can use the Knock management API to:

• Create, update, and manage your Knock workflows and the notification templates within those workflows.
• Create, update and manage your email layouts.
• Create and manage the translations used by your notification templates.
• Create, update, and manage your partials.
• Commit and promote changes between your Knock environments.

The management API authenticates with a Bearer authentication mechanism using a service token generated on your account.

Note: environment-level API keys should never be used to authenticate with the management API. To authenticate with the management API, generate a service token.

Knock uses standard HTTP response codes to indicate the success or failure of your API requests.

• 2xx success status codes confirm that your request worked as expected.
• 4xx error status codes indicate an error caused by incorrect or missing request information (e.g. providing an incorrect API key).
• 5xx error status codes indicate a Knock server error.

You can use our Management API Postman collection to quickly get started testing our Management API.