Skip to navigation

Update

Turn auto-join, the access restriction or the allow-list for go links and events on or off. An unverified domain cannot be changed: 409 needs_verifying.

Authentication

AuthorizationBearer

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

Path parameters

domainIdstringRequired

Request

This endpoint expects an object.
autoJoinbooleanOptional

Turned on while the workspace’s autoGrowSeats is on, seats grow as people join from then on, so everybody on a waiting list is given a seat at once and the seats paid for rise to fit them.

restrictAccessbooleanOptional
allowListedbooleanOptional

Off turns its people away from every go link and event at once; links and events that chose it keep it, counting for nothing until it is turned on again.

Response

This endpoint returns an object.
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.

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.

createdAtdatetime
domainstring
idstring
outsidersinteger
With access restricted, how many members are already here with an address outside the verified domains. They keep their access.
restrictAccessboolean
verificationobject
The DNS record that proves the workspace owns the domain.
verifiedboolean
verifiedAtdatetimeOptional

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Validation Error
429
Too Many Requests Error