Claim Enterprise Domain

View as Markdown

Allows a verified user to claim their email domain for their current workspace. This action will:

  1. Verify the user’s email is not from a free provider.
  2. Link the current workspace to the enterprise domain.
  3. Set the default role for new joiners.

Request

This endpoint expects an object.
default_roleenumOptional
The role assigned to users when they auto-join this workspace. * `VIEWER` - VIEWER * `EDITOR` - EDITOR * `ADMIN` - ADMIN
Allowed values:

Response

Domain claimed successfully
idintegerRead-only
domainstringRead-only
admininteger or nullRead-only
The admin who claimed this domain
is_verifiedbooleanRead-only
created_atdatetimeRead-only
workspaceslist of objectsRead-only

Errors

400
Bad Request Error