Skip to main content
PUT
/
providers
/
{id}
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const provider = await client.providers.update('id', { provider: 'provider' });

console.log(provider.id);
{
  "id": "<string>",
  "title": "<string>",
  "provider": "<string>",
  "settings": {},
  "created": 123,
  "alias": "<string>",
  "updated": 123
}

Documentation Index

Fetch the complete documentation index at: https://www.courier.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.

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).

​
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.