Setup

Can this project send?

GET
/api/v1/connection

One call for the whole readiness question: provider connected, domains verified, default sender present, webhooks registered, kill switch off. Meant as a deploy-time preflight.

Note there is no way to SET a provider API key over this API — credentials only ever enter through the dashboard (settings_url), so a leaked aem_ key can't repoint your sending.

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

Response Body

Setup status.

application/json
  1. response
ready?boolean

True when this project can actually send right now.

provider?|null
domains?array<>

Per-domain status incl. advisory dmarc_status (unknown | missing | found) — DMARC is not part of ready.

senders?array<>
sends_paused?boolean
daily_send_cap?integer|null
settings_url?string

Where a human pastes the provider API key.

Example Request
curl -X GET 'https://sendandretain.com/api/v1/connection'
Example Response
{  "ready": true,  "provider": {    "name": "resend",    "status": "string",    "webhook_registered": true,    "error_message": "string"  },  "domains": [    {}  ],  "senders": [    {}  ],  "sends_paused": true,  "daily_send_cap": 0,  "settings_url": "string"}