Developers
Email settings7

Retrieve email settings

GET/settings/emails

Returns the email settings of the account: sender, signature, reply-to address, email branding, and sending status, including the sending limit and the number of emails sent in the current period.

The response includes an ETag representing the current revision of these settings; changes to other settings groups do not affect it. Send this value in the If-Match header when updating these settings to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/settings/emails"
{  "data": {    "branding": {      "background_color": "string",      "card_color": "string",      "link_color": "string",      "logo": {        "file_id": "string",        "url": "string"      },      "text_color": "string"    },    "defaults": {},    "object": "settings",    "propagation": {},    "replica": {},    "reply_to": "string",    "revision": "string",    "sender": {      "address": "string",      "name": "string",      "signature": "string"    },    "status": {      "can_send": true,      "limit": 0,      "sending_disabled": true,      "sent_in_period": 0    }  }}

Email settings7

Email settings in API v3: retrieve email settings, update email settings, list email templates, retrieve an email template, update an email template, preview an email template, send a test email.

Update email settings PATCH

Updates the email settings. Only the fields included in the request are changed: setting a field to `null` clears its configured value and restores the default, and omitted fields are left unchanged. To avoid overwriting a newer version, send the `ETag` returned by the retrieve operation in the `If-Match` header. The header is optional; when it is omitted, the update is applied to the current revision.