> ## 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 an account invitation
> Create an account invitation for the given `email`, `organization_id`, and `product`. After the successful creation, it sends an email to all users with the invitation approval scopes, informing them about the new account awaiting the approval. `organization_id` and `creator_id` are retrieved from the access token.
**Required scopes:** `accounts.invitations--my:rw`
## OpenAPI
````yaml /api/global-accounts/openapi.json post /accounts/invitations
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:
/accounts/invitations:
post:
tags:
- Accounts
summary: Create an account invitation
description: >-
Create an account invitation for the given `email`, `organization_id`,
and `product`. After the successful creation, it sends an email to all
users with the invitation approval scopes, informing them about the new
account awaiting the approval. `organization_id` and `creator_id` are
retrieved from the access token.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
properties:
email:
type: string
description: Email address of the invited account.
name:
type: string
description: >-
The name of the invited account (nick; first, second name;
or both). If an invitation was issued to an existing
account, this field will be replaced with the name assigned
to that account.
product:
type: string
description: The product to which an account is invited.
example:
email: john@example.com
name: John
product: LiveChat
responses:
'200':
description: 'OK: Returns an existing account''s invitation ID.'
content:
application/json:
schema:
type: object
properties:
invitation_id:
type: string
format: uuid
description: Unique account invitation identifier.
example:
invitation_id: 496a94f2-cbbf-444e-a3cb-305b9f5f8cbb
'201':
description: 'Created: Account invitation was created.'
content:
application/json:
schema:
type: object
properties:
invitation_id:
type: string
format: uuid
description: Unique account invitation identifier.
example:
invitation_id: 496a94f2-cbbf-444e-a3cb-305b9f5f8cbb
'400':
description: >-
Bad Request: Invalid request; the invitation name for the new
account is empty.
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: bad_request
error_description: >-
The server cannot or will not process the request due to an
apparent client error (for example, malformed request syntax,
size too large).
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'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
'409':
description: 'Conflict: Account already added to the product.'
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 email, 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:
email:
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:
- accounts.invitations--my:rw
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: {}
````