Update an email domain of an organization
A unique entity identifier
^[a-zA-Z0-9_-]+$Email domain
Role given to people who join through the domain. "default" uses the organization's default role, and "guest" adds them as guests.
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
ID of a team of the organization, or null to add no team
Domain updated
An email domain of an organization.
The object type, which is always "organization-domain"
The email domain, such as "example.com"
Verification status of the domain. "legacy" is a domain added before verification existed: it keeps letting people join automatically without being verified.
Why the last verification failed
Whether people with an email on the domain join the organization automatically
Role given to people who join through the domain. "default" uses the organization's default role, and "guest" adds them as guests.
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
ID of the team that people joining through the domain are added to
Date the domain was verified
Date the domain was added
Bad Request
Not Found
PATCH /v1/orgs/{organizationId}/domains/{emailDomain} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"autoJoinEnabled": true,
"defaultRole": "admin",
"defaultTeam": null
}{
"object": "organization-domain",
"domain": "text",
"status": "legacy",
"statusDescription": "text",
"verificationRecord": {
"type": "TXT",
"name": "text",
"value": "text"
},
"autoJoinEnabled": true,
"defaultRole": "admin",
"defaultTeam": "text",
"verifiedAt": "2026-01-01T00:00:00.000Z",
"createdAt": "2026-01-01T00:00:00.000Z",
"urls": {
"location": "https://example.com"
}
}Last updated
Was this helpful?