Skip to main content
PATCH
Update a configuration set
Requires the IAM action email:UpdateConfigurationSet. See EMAIL permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

configuration_set_id
string<uuid>
required

Body

application/json
sending_enabled
boolean
suppression_overrides
string[]
ip_pool
string | null

UUID, CRN or account-unique name. Omit to preserve; null detaches the pool.

Minimum string length: 1
tracking_open
boolean
tracking_click
boolean
tags
object
Example:

Response

The updated configuration set.

configuration_set
object
required