Skip to main content
PUT
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 replacing an existing provider configuration. The provider key is required because it determines which provider-specific settings schema is validated against. Changing the provider type for an existing configuration is not supported. All other fields are optional — omitted fields are cleared from the stored configuration (this is a full replacement, not a partial merge).

provider
string
required

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

Maximum string length: 128
title
string

Updated display title.

alias
string

Updated alias. Omit to clear.

settings
object

Provider-specific settings (snake_case keys). Replaces the full settings object — omitted settings fields are removed. Use the catalog endpoint to check required fields. Set rate_limit to cap this configuration's send rate: { "rate": <number greater than 0>, "period": "second" | "minute" | "hour" }, e.g. { "rate": 0.5, "period": "minute" } for one send every 2 minutes. The interval between sends (period divided by rate) must be from 1 millisecond to 12 hours, otherwise the request returns a 400 InvalidRateLimit error. The limit applies per configuration and per environment (a test-environment configuration has its own limit). Sends above the rate are queued, not dropped, and changes take up to 60 seconds to apply. It has no effect on observability or CDP integrations, which do not send messages. Omitting rate_limit or setting it to null removes any existing limit, including one set in Studio.

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.