Skip to main content
POST
Create a new account
Required scopes: accounts--all:rw, accounts--all:rc accounts.roles--all:rw

Authorizations

Authorization
string
header
required

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.

Body

application/json

An entity of the account, used across all Text products.

email
string<email>
required

The account's email address.

Maximum string length: 128
name
string

The account name (nick; first name, second name, or both).

Maximum string length: 191
default_product
enum<string>

The default product for the account.

Available options:
LiveChat,
Accounts,
ChatBot,
HelpDesk,
OpenWidget
default_organization_id
string<uuid> | null

The ID of the default organization the account belongs to.

avatar_url
string | null
deprecated

The "Account's avatar" field has been deprecated and is no longer recommended for use; instead, the avatar functionality has been relocated to the account organization settings.

Maximum string length: 255
roles
object[]

Roles associated with the account; returned only when the access token contains the accounts.roles--all:ro scope.

Role groups account scopes into one permission entity.

password
string
write-only

The password for a given account.

Required string length: 8 - 255

Response

OK: Returns the already existing account.

An entity of the account, used across all Text products.

email
string<email>
required

The account's email address.

Maximum string length: 128
account_id
string<uuid>
read-only

Unique account identifier.

name
string

The account name (nick; first name, second name, or both).

Maximum string length: 191
email_verified
boolean
read-only

If true: the account's email was verified via an email action or by a third-party identity provider.

default_product
enum<string>

The default product for the account.

Available options:
LiveChat,
Accounts,
ChatBot,
HelpDesk,
OpenWidget
default_organization_id
string<uuid> | null

The ID of the default organization the account belongs to.

avatar_url
string | null
deprecated

The "Account's avatar" field has been deprecated and is no longer recommended for use; instead, the avatar functionality has been relocated to the account organization settings.

Maximum string length: 255
roles
object[]

Roles associated with the account; returned only when the access token contains the accounts.roles--all:ro scope.

updated_at
string<date-time>
read-only

The date of the account's last update.

created_at
string<date-time>
read-only

The date the account was created.