> ## Documentation Index
> Fetch the complete documentation index at: https://www.text.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Create organization domain
> This endpoint adds a new domain to the organization's email address domains whitelist. It's forbidden to add domains used for disposable email addresses or used by free email providers. Maximum number of domains added to an organization is 10.
## OpenAPI
````yaml /api/global-accounts/openapi.json post /organizations/{organization_id}/domains
openapi: 3.0.0
info:
title: Global Accounts API
description: >-
API used to manage Organizations and Accounts for multiple products. Also
responsible for authorization and authentication processes.
version: 2.0.0
servers:
- url: https://accounts.livechat.com/v2
description: Main production server URL
security: []
paths:
/organizations/{organization_id}/domains:
post:
tags:
- OrganizationDomains
summary: Create organization domain
description: >-
This endpoint adds a new domain to the organization's email address
domains whitelist. It's forbidden to add domains used for disposable
email addresses or used by free email providers. Maximum number of
domains added to an organization is 10.
parameters:
- in: path
name: organization_id
schema:
type: string
format: uuid
default: my
readOnly: true
description: Unique organization identifier.
required: true
description: Unique organization ID.
requestBody:
content:
application/json:
schema:
description: The parameters for creating an organization domain.
type: object
properties:
domain:
type: string
description: The domain name.
required:
- domain
example:
domain: text.com
application/x-www-form-urlencoded:
example:
avatar_url: example.com
schema:
description: The parameters for creating an organization domain.
type: object
properties:
domain:
type: string
description: The domain name.
required:
- domain
required: true
responses:
'201':
description: 'Created: Returns created organization domain.'
content:
application/json:
schema:
description: Organization domain.
type: object
properties:
organization_id:
type: string
format: uuid
default: my
readOnly: true
description: Unique organization identifier.
domain_id:
type: string
format: uuid
readOnly: true
description: Unique domain identifier.
domain:
type: string
description: The domain name.
type:
readOnly: true
type: string
description: >-
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:
readOnly: true
type: string
format: date-time
description: The creation date of the organization domain.
example:
organization_id: b2185556-634c-4ecf-b4c9-bcf8b65bc853
domain_id: e4f1235b-0e43-4b79-ae40-3ea56e53bb3a
domain: text.com
type: open
created_at: '2026-06-03T10:53:04.000Z'
'401':
description: Unauthorized, missing, or invalid authorization.
content:
application/json:
schema:
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
error:
type: string
error_description:
type: string
example:
error: unauthorized
error_description: The account is not authorized.
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'404':
description: Resource not found.
content:
application/json:
schema:
allOf:
- description: Returned on validation errors.
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
resource_name:
description: The name of the resource related to the error.
type: string
resource_id:
description: >-
The identifier of the resource related to the
error.
type: string
- type: object
properties:
error:
type: string
error_description:
type: string
example:
error: resource_not_found
error_description: The requested resource couldn't be found.
resource_name: account
resource_id: def31e95-5ca4-4817-b176-732e4544daca
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'409':
description: 'Conflict: The domain already exists.'
content:
application/json:
schema:
allOf:
- description: Returned on validation errors.
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
resource_name:
description: The name of the resource related to the error.
type: string
resource_id:
description: >-
The identifier of the resource related to the
error.
type: string
- type: object
properties:
error:
type: string
error_description:
type: string
example:
error: conflict
error_description: >-
The request couldn't be processed because of conflict in the
current state of the resource.
resource_name: account
resource_id: 5903c51b-89f0-41a9-a25d-4f39af100353
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'422':
description: 'Validation error: Invalid uuid, etc.'
content:
application/json:
schema:
allOf:
- allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
error:
type: string
error_description:
type: string
invalid_fields:
type: object
additionalProperties:
type: string
- type: object
properties:
invalid_fields:
type: object
properties:
domain:
type: string
example:
error: invalid_request
error_description: >-
The request is missing a required parameter, includes an
invalid parameter value, includes a parameter more than once,
or is otherwise malformed.
invalid_fields:
email: invalid email address
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'500':
description: Server Error.
content:
application/json:
schema:
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
error:
type: string
error_description:
type: string
example:
error: server_error
error_description: >-
The server encountered an unexpected condition that prevented
it from fulfilling the request.
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
security:
- PersonalAccessToken: []
- OAuth2BearerToken: []
components:
securitySchemes:
PersonalAccessToken:
description: >-
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.
type: http
scheme: basic
OAuth2BearerToken:
description: >-
This API uses OAuth2 with the implicit grant flow. Learn about
the implicit grant flow.
type: oauth2
flows:
implicit:
authorizationUrl: https://accounts.livechat.com
scopes: {}
authorizationCode:
authorizationUrl: https://accounts.livechat.com
tokenUrl: https://accounts.livechat.com/token
scopes: {}
````