Patch a Provider
Updates part of a provider’s configuration and keeps every field you omit. Settings merge into the stored settings key by key, and a setting sent as null is removed.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A unique identifier of the provider configuration to update.
Body
Request body for a partial update of a provider configuration. Every field is optional, and a field you omit keeps its stored value. The body must include at least one of title, alias, or settings, otherwise the request returns a 400. The provider type of an existing configuration cannot be changed.
The provider key identifying the type. Optional. When sent, it must match the stored provider, otherwise the request returns a 400.
128Updated display title.
Updated alias. Set to null to clear it.
Provider-specific settings (snake_case keys) to merge into the stored settings, using JSON Merge Patch (RFC 7396). Each key you send replaces the stored value, a key set to null is removed, nested objects merge recursively, and arrays replace the stored value. Keys you omit keep their stored values. Set rate_limit to null to remove this configuration's send rate limit.
Response
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). rate_limit is this configuration's send rate limit, { "rate": number, "period": "second" | "minute" | "hour" }, or null for no limit.
Unix timestamp (ms) of when the provider was created.
Optional alias for this configuration.
Unix timestamp (ms) of when the provider was last updated.