Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

A unique identifier of the provider configuration to update.

Body

application/json

Request body for a partial update of a provider configuration: a list of JSON Patch (RFC 6902) operations, the same body as the profile and preference PATCH endpoints.

patch
ProvidersPatchOperation · object[]
required

Operations to apply, in order. Paths address the provider as it is returned: /title, /alias, /provider, and /settings/<key> with the snake_case setting keys, including nested paths such as /settings/rate_limit/rate. If any operation fails, for example a test, nothing is saved and the request returns a 400. The result can't change provider, remove title, or add other top-level fields. Removing /alias clears it.

Minimum array length: 1

Response

A configured provider in the workspace.

id
string
required

A unique identifier for the provider configuration.

title
string
required

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

provider
string
required

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

settings
object
required

Provider-specific settings (snake_case keys on the wire). rate_limit is this configuration's send rate limit, { "rate": number, "period": "second" | "minute" | "hour" }, or null for no limit.

created
integer
required

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

alias
string

Optional alias for this configuration.

updated
integer | null

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