Update email settings
/settings/emailsUpdates 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/settings/emails" \ -H "Content-Type: application/json" \ -d '{}'{ "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 } }}Retrieve email settings GET
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. Send this value in the `If-Match` header when updating these settings to avoid overwriting a newer version.
List email templates GET
Returns the complete email template catalog in a single response. The catalog is fixed: templates cannot be created or deleted.