Create a provider
Configures a provider integration from a Courier provider key and its settings. Check the catalog endpoint for the schema each provider expects.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.
How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.
Body
Request body for creating a new provider configuration.
The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a known Courier provider — see the catalog endpoint for valid keys.
128Optional display title. Omit to use "Default Configuration".
Optional alias for this configuration.
Provider-specific settings (snake_case keys). Defaults to an empty object when omitted. Use the catalog endpoint to discover required fields for a given provider — omitting a required field returns a 400 validation error.
Response
Created
A configured provider in the workspace.
A unique identifier for the provider configuration.
Display title. Defaults to "Default Configuration" when not explicitly set.
The provider key (e.g. "sendgrid", "twilio", "slack").
Provider-specific settings (snake_case keys on the wire).
Unix timestamp (ms) of when the provider was created.
Optional alias for this configuration.
Unix timestamp (ms) of when the provider was last updated.