Skip to main content
POST
Create organization domain

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Path Parameters

organization_id
string<uuid>
default:my
required
read-only

Unique organization ID. Unique organization identifier.

Body

The parameters for creating an organization domain.

domain
string
required

The domain name.

Response

Created: Returns created organization domain.

Organization domain.

organization_id
string<uuid>
default:my
read-only

Unique organization identifier.

domain_id
string<uuid>
read-only

Unique domain identifier.

domain
string

The domain name.

type
string
read-only

Type of the domain assigned to the organization. Only one type is available - open. Open domains are email domains that are able to join a given organization without additional confirmation.

created_at
string<date-time>
read-only

The creation date of the organization domain.