Sign in
Providers

Update a provider

Replaces a provider's configuration in full, clearing any field you omit rather than merging it. Send the complete settings object.

put/providers/{id}

Path parameters

idstring required

A unique identifier of the provider configuration to update.

Request body

providerstring required

The provider key identifying the type. Required on every request because it selects the provider-specific settings schema for validation.

titlestring

Updated display title.

aliasstring

Updated alias. Omit to clear.

settingsobject

Provider-specific settings (snake_case keys). Replaces the full settings object — omitted settings fields are removed. Use the catalog endpoint to check required fields.

Response

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

Changed in 1 of the 55 revisions of this API.1