Settings

Set the kill switch, daily cap, auto-UTM tagging, or default locale

PATCH
/api/v1/settings

sends_paused: true stops all sending for this project — API, automations and copilot alike — and is re-checked on the worker path, so it stops queued mail too, not just new calls. Because of that it requires confirm: true; resuming does not. utm configures auto UTM tagging, which is already on with sensible defaults: send it only to change the params or to switch tagging off. default_locale is the fallback used to pick a template translation when neither the send call nor the contact carries a locale (null = the base template language). Requires an admin-scope key.

Authorization

bearerAuth admin
headerAuthorizationBearer <token>

An API key from the dashboard under Settings → API keys, sent as Authorization: Bearer aem_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see messages, contacts and metrics. Changes nothing, and cannot send.
  • write — everything read does, plus managing templates, contacts, automations, segments and suppressions. This is what editing a template needs.
  • admin — everything write does, plus sending configuration: domains, senders, webhook registration, kill switch, daily cap, brand.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Delivering mail to a real inbox needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

Give your application the lowest tier that works. Most need write and the grant — the dashboard mints that combination as Send + manage; Manage only is the same rung with the grant withheld.

Scope: admin

Request Body

application/json
  1. body
sends_paused?boolean

The kill switch. true stops ALL sending for this project.

daily_send_cap?integer

Self-imposed daily ceiling. 0 = rely on the provider plan limit.

Range0 <= value <= 1000000
utm?|

Auto UTM tagging, on by default. params are appended to every external link in outgoing emails (existing URL params always win). Values may embed {{automation}}, {{step}}, {{template}}, {{variant}}, {{source}} — resolved per send, slugified, and omitted when empty. Max 10 params, lowercase snake_case keys. Send { "enabled": false, "params": {} } to switch tagging off; null clears your override and restores the defaults.

default_locale?|

Fallback locale for template translation picks (tag like fr or pt-BR) when neither the send call nor the contact carries one. null clears it — sends fall back to the base template language.

confirm?boolean

Required (true) to pause. Resuming needs no confirmation.

Response Body

Settings updated.

application/json
  1. response
sends_paused?boolean
daily_send_cap?integer
utm?|null
default_locale?string|null
Example Request
curl -X PATCH 'https://sendandretain.com/api/v1/settings' \  -H 'Content-Type: application/json' \  -d '{  "sends_paused": true,  "confirm": true}'
Example Response
{  "sends_paused": true,  "daily_send_cap": 2000,  "utm": {},  "default_locale": "string"}