Sign in

v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Organization Domains

Update an organization domain.

Updates the properties of an existing organization domain.

patch/organizations/{organization_id}/domains/{domain_id}

Path parameters

organization_idstring required

The ID of the organization to which the domain belongs

domain_idstring required

The ID of the domain

Request body

enrollment_modestring nullable

The enrollment_mode for the new domain. This can be automatic_invitation, automatic_suggestion, manual_invitation or enterprise_sso

verifiedboolean nullable

The status of the domain's verification

Response

An organization domain

object'organization_domain' required

String representing the object's type. Objects of the same type share the same value. Always organization_domain

idstring required

Unique identifier for the organization domain

organization_idstring required

Unique identifier for the organization

namestring required

Name of the organization domain

enrollment_mode'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion' | 'enterprise_sso' required

Mode of enrollment for the domain

affiliation_email_addressstring nullable required

Affiliation email address for the domain, if available.

total_pending_invitationsinteger required

Total number of pending invitations associated with this domain

total_pending_suggestionsinteger required

Total number of pending suggestions associated with this domain

created_atinteger required

Unix timestamp when the domain was created

updated_atinteger required

Unix timestamp of the last update to the domain