Organization Domain

Update an organization domain.

Updates the properties of an existing organization domain.

SecuritybearerAuth
Request
path Parameters
organization_id
required
string

The ID of the organization the domain belongs to

domain_id
required
string

The ID of the domain

Request Body schema: application/json
required
enrollment_mode
string or null

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

verified
boolean or null

The status of the domain's verification

Responses
200

An organization domain

400

Request was not successful

404

Resource not found

422

Invalid request parameters

patch/organizations/{organization_id}/domains/{domain_id}
Request samples
application/json
{
  • "enrollment_mode": "string",
  • "verified": true
}
Response samples
application/json
{
  • "id": "string",
  • "object": "organization_domain",
  • "organization_id": "string",
  • "name": "string",
  • "enrollment_mode": "manual_invitation",
  • "affiliation_email_address": "string",
  • "verification": {
    },
  • "total_pending_invitations": 0,
  • "total_pending_suggestions": 0,
  • "created_at": 0,
  • "updated_at": 0
}