Skip to Content
SendlySendly
API ReferenceDomains

Add a sending domain

POST
/api/domains

Register a new domain with SES and persist its DKIM tokens. The response lists every DNS record to publish in dnsRecords; publish them, then poll GET /api/domains/{id}/verify.

Requires the domains:write scope — Add and remove sending domains, and trigger verification.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

application/json
  1. body

Body for POST /api/domains. projectId is optional for API-key auth (derived from key) and required for session auth. region pins the SES region; on the first domain it locks the project, after that it must match the project's region. stream assigns the identity to transactional or marketing traffic at creation; omit it to leave the identity serving both.

projectId?string
Formatuuid
domain*string
Length3 <= length <= 253
region?string

Override SES region for this domain. Defaults to the project region or the env default. Required to match an existing project region.

Value in"us-east-1""us-west-2""eu-west-1"
stream?SendingStream

Which traffic this identity carries. Omit to leave it unassigned, which lets it carry every stream — that is what every domain added before per-stream identities does.

Value in"TRANSACTIONAL""MARKETING"
streamDefault?boolean

Make this the project's default identity for stream. Requires stream. Setting it demotes whichever identity held it.

Response Body

Domain added

application/json
  1. response
success*true
Value intrue
data*

A newly added sending identity, with the DNS records to publish for it.

Example Request
curl -X POST 'https://api.sendly.now/api/domains' \  -H 'Content-Type: application/json' \  -d '{  "domain": "string"}'
Example Response
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "domain": "string",    "verified": true,    "region": "string",    "dkimTokens": [      "string"    ],    "dkimStatus": "NOT_CHECKED",    "spfStatus": "NOT_CHECKED",    "dmarcStatus": "NOT_CHECKED",    "lastHealthCheckAt": "2019-08-24T14:15:22Z",    "receivingEnabled": true,    "mailFromDomain": "string",    "mailFromDomainStatus": "Pending",    "stream": "TRANSACTIONAL",    "streamDefault": true,    "defaultFromAddress": "string",    "defaultFromName": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "dnsRecords": [      {        "type": "string",        "name": "string",        "value": "string",        "purpose": "dkim"      }    ]  }}