Add a sending domain to a brand
A domain the brand's email can come from, on a plan with `branding.custom_email_domain` (Pro and up). It belongs to the brand alone, and moves with it to another org. Synq registers it with its email provider at once and answers the DNS records to publish; when it can't yet, the domain is `pending_setup` and its records appear once it can. A name is held by one org at a time. At most 10 a day, and 10 in all across the org's brands. Needs `org.emailDomains.edit` in the brand. Recorded as `email_domain.created`.
/v1/orgs/{org}/brands/{brand}/email-domainsA domain the brand's email can come from, on a plan with branding.custom_email_domain (Pro and up). It belongs to the brand alone, and moves with it to another org. Synq registers it with its email provider at once and answers the DNS records to publish; when it can't yet, the domain is pending_setup and its records appear once it can. A name is held by one org at a time. At most 10 a day, and 10 in all across the org's brands. Needs org.emailDomains.edit in the brand. Recorded as email_domain.created.
Authorization
bearer An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.
In: header
Path Parameters
The org's id
^org_[0-9a-hjkmnp-tv-z]{26}$The brand's id
^brd_[0-9a-hjkmnp-tv-z]{26}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/email-domains" \ -H "Authorization: Bearer $SYNQ_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "domain": "mail.acme.com" }'{ "id": "edm_01h455vb4pex5vsknk084sn02q", "domain": "mail.acme.com", "status": "pending_dns", "records": [ { "purpose": "dkim", "type": "TXT", "host": "20261006120000pm._domainkey.mail.acme.com", "value": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQ…", "required": true, "status": "unchecked", "seen": "string" } ], "problem": "record_missing", "brand": "brd_01h455vb4pex5vsknk084sn02q", "in_use": true, "verified_at": "2026-10-21T12:00:00.000Z", "last_checked_at": "2026-10-21T12:00:00.000Z", "created_at": "2026-10-21T12:00:00.000Z"}Check a brand's sending domain now POST
Looks at the domain again now rather than at its next scheduled check: registers it if it is still `pending_setup`, else looks its records up and, when they are all there and Postmark agrees, verifies it. Once a minute for a domain. Needs `org.emailDomains.edit` in the brand and a plan with `branding.custom_email_domain`.
Get a file GET
Its state, and where it is read once ready. Needs `org.brands.view`.