DevelopersAPI referenceAuth & accountsDomains
Switch suggest / auto-join
org.domains.manage.
View as MarkdownAuthorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
id*string
did*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/orgs/string/domains/string" \ -H "Content-Type: application/json" \ -d '{ "mode": "suggest" }'{ "domain": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "domain": "string", "mode": "suggest", "verified_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "verification_record": { "type": "TXT", "name": "_easerix.acme.com", "value": "easerix-verification=<token>" } }}Claim a domain
org.domains.manage, team orgs only. The domain is normalized (scheme, www, path and trailing dot stripped, lowercased). Public email providers are rejected, as is a domain already verified elsewhere. The claim starts unverified and returns the TXT record to publish.
Remove a domain claim
org.domains.manage. Existing members are unaffected — only future discovery stops.