Domains

Add a sending domain

Register a new domain with SES and persist its DKIM tokens.

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

post/api/domains

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/domains
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: domains:write)

Request body

domainstring required
projectIdstring uuid
region'us-east-1' | 'us-west-2' | 'eu-west-1'

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

stream'TRANSACTIONAL' | 'MARKETING'

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.

streamDefaultboolean

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

Response

Domain added

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.