Providers

Create a provider

Create a new provider configuration. The provider field must be a known Courier provider key (see catalog).

post/providers

Request body

providerstring required

The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a known Courier provider — see the catalog endpoint for valid keys.

titlestring

Optional display title. Omit to use "Default Configuration".

aliasstring

Optional alias for this configuration.

settingsobject

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

idstring required

A unique identifier for the provider configuration.

titlestring required

Display title. Defaults to "Default Configuration" when not explicitly set.

providerstring required

The provider key (e.g. "sendgrid", "twilio", "slack").

aliasstring

Optional alias for this configuration.

settingsobject required

Provider-specific settings (snake_case keys on the wire).

createdinteger required

Unix timestamp (ms) of when the provider was created.

updatedinteger nullable

Unix timestamp (ms) of when the provider was last updated.

Changes