SynqDocs
Management APIDomains

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`.

POST/v1/orgs/{org}/domains

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.

Authorization

bearer
AuthorizationBearer <token>

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

org*string

The org's id

Match^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"}