Add a domain to verify
A domain the org proves it owns, so its people can sign in through its own identity provider: on a plan with `team.sso` (Enterprise). It starts `pending`, with the TXT record to publish; then verify it. Several orgs may add a name, and the first to prove it holds it. At most 10 added a day, and 20 in all. Needs `org.sso.edit` across the org. Recorded as `org_domain.created`.
/v1/orgs/{org}/domainsA domain the org proves it owns, so its people can sign in through its own identity provider: on a plan with team.sso (Enterprise). It starts pending, with the TXT record to publish; then verify it. Several orgs may add a name, and the first to prove it holds it. At most 10 added a day, and 20 in all. Needs org.sso.edit across the org. Recorded as org_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}$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/domains" \ -H "Authorization: Bearer $SYNQ_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "domain": "acme.com" }'{ "id": "odm_01h455vb4pex5vsknk084sn02q", "domain": "acme.com", "status": "pending", "verification": { "type": "TXT", "host": "_synq-verification.acme.com", "value": "synq-verification=k7q2m5x9a3b4c6d8e2f7g5h3j9k4m2n6" }, "problem": "record_not_found", "verified_at": "2026-10-21T12:00:00.000Z", "failing_until": "2026-10-21T12:00:00.000Z", "last_checked_at": "2026-10-21T12:00:00.000Z", "created_at": "2026-10-21T12:00:00.000Z"}Verify a domain now POST
Reads the domain's TXT record through public DNS now. When every public resolver that answers sees it, and no other org holds the name, the domain is `verified`; otherwise it stays as it was, and `problem` says why. A verified domain is also read again every day. Six times a minute for a domain. Needs `org.sso.edit` across the org and a plan with `team.sso`. Recorded as `org_domain.verified` when it verifies.
Delete a brand's sending domain DELETE
Its name is free at once, and Synq removes it from its email provider. Refused while the brand's email is set to come from it. On any plan, so an org that moved down can clean up. Needs `org.emailDomains.edit` in the brand. Recorded as `email_domain.deleted`.