Setup

Edit a sender

PATCH
/api/v1/senders/{id}

Changes the display name, Reply-To, or which sender is the project default. from_email is deliberately not editable — a new address needs re-validating against a verified domain, so that's a create.

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

Path Parameters

id*string

Sender id.

Request Body

application/json
  1. body
from_name?string

New display name.

Length1 <= length <= 120
reply_to?|

New Reply-To. null clears it.

is_default?boolean

Pass true to make this the project default (demotes the previous one).

Response Body

Sender updated.

application/json
  1. response
id?string
is_default?boolean
Example Request
curl -X PATCH 'https://sendandretain.com/api/v1/senders/string' \  -H 'Content-Type: application/json' \  -d '{  "from_name": "Acme Support"}'
Example Response
{  "id": "string",  "is_default": true}