Skip to navigation

Create

Claim a domain. Publish the TXT record in verification, then call verify. Requires domains:write. Errors: 422 invalid_domain, 422 public_domain, 409 already_claimed, 409 verified_elsewhere (another workspace verified it first).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
domainstringRequired

Just the domain, acme.com, not an address. Shared mailbox providers cannot be claimed.

Response

This endpoint returns an object.
idstring
domainstring
verifiedboolean
autoJoinboolean

People who sign in with a confirmed address at the domain join as members, with a seat on each app that gives new members one. While it is on and the workspace’s autoGrowSeats is too (PATCH /organization), an app whose seats are all taken gets one more for them, and the seats paid for grow with it, prorated; otherwise they go on that app’s waiting list (GET /seats/waiting) and owners and admins are emailed.

restrictAccessboolean
allowListedboolean

On the workspace’s allow-list for go links and Dory events set to “People at certain email domains”, once verified: its people may prove an address and follow those links and join those events, without becoming members. On by default.

verificationobject
The DNS record that proves the workspace owns the domain.
createdAtdatetime
verifiedAtdatetimeOptional

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Validation Error
429
Too Many Requests Error