Add a sending domain
Register a domain and start SES DKIM verification. The response carries the identity as created — verified is false, because nothing is verified until the DKIM records are published in the domain's DNS and SES resolves them. Poll /api/v1/domains/{id}/verify after publishing them.
region pins the SES region. The first domain a project adds LOCKS the project to that region and every later domain must match it — a project split across regions would have its SES configuration diverge silently.
stream assigns the identity to transactional or marketing traffic at creation; omit it to leave the identity serving both. stream_default makes it the project's default for that stream and therefore requires stream — sending it alone answers 422 validation_error rather than being ignored.
A host already registered — to this project or to another — answers 409 conflict when the caller can already send from it and 403 project_access_denied when it belongs elsewhere. A subdomain whose registrable root is held by a suspended project is refused the same way.
Requires the domains:write scope — Add and remove sending domains, and trigger verification.
AuthorizationBearer <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- body
Body for POST /api/v1/domains.
domain*string3 <= length <= 253region?stringAWS SES region for the project. Once a domain is added the region is locked and cannot be changed.
"us-east-1""us-west-2""eu-west-1"stream?stringWhich traffic a sending identity carries. An identity with no stream serves both, which is how every domain added before per-stream identities behaves.
"TRANSACTIONAL""MARKETING"stream_default?booleanMake this the project's default identity for stream. Requires stream.
The registered sending domain, awaiting DNS
application/json- response
A sending domain as exposed on the v1 API.
id*stringuuiddomain*stringverified*booleanregion*string|nullstream*stringWhich traffic a sending identity carries. An identity with no stream serves both, which is how every domain added before per-stream identities behaves.
"TRANSACTIONAL""MARKETING"stream_default*booleandefault_from_address*string|nulldefault_from_name*|The display name recipients see beside any address on this domain when a send names none. null falls back to the project name.
mail_from_domain*string|nullmail_from_domain_status*|SES's CustomMailFromStatus for mail_from_domain — the subdomain that carries the bounce path, NOT the status of any From address.
dkim_verified*booleancreated_at*stringdate-timeupdated_at*stringdate-timecurl -X POST 'https://api.sendly.now/api/v1/domains' \ -H 'Content-Type: application/json' \ -d '{ "domain": "string"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "domain": "string", "verified": true, "region": "string", "stream": "string", "stream_default": true, "default_from_address": "string", "default_from_name": "string", "mail_from_domain": "string", "mail_from_domain_status": "string", "dkim_verified": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}