Platform API · Users

Create a User

POST/platform/api/v1/users

Authorization

api_access_tokenheaderrequired

A platform app's token. Platform apps exist only on a dedicated instance, made in its super admin console. On Texa's shared hosting this API is not open to companies.

Body application/json

namestring

Name of the user

display_namestring

Display name of the user

emailstring

Email of the user

passwordstring

Password must contain uppercase, lowercase letters, number and a special character

custom_attributesobject

Custom attributes you want to associate with the user

Responses

200

Success

idnumber

access_tokenstring

account_idnumber

available_namestring

avatar_urlstring

confirmedboolean

display_namestring

message_signaturestring

emailstring

hmac_identifierstring

inviter_idnumber

namestring

providerstring

pubsub_tokenstring

rolestring

One of: agent, administrator.

ui_settingsobject

uidstring

typestring

custom_attributesobject

Available for users who are created through platform APIs and has custom attributes associated.

accountsarray of object

accounts[].idnumber

accounts[].namestring

accounts[].statusstring

accounts[].active_atstring (date-time)

accounts[].rolestring

One of: administrator, agent.

accounts[].permissionsarray of string

accounts[].availabilitystring

accounts[].availability_statusstring

accounts[].auto_offlineboolean

accounts[].custom_role_idnumber

accounts[].custom_roleobject

401

Unauthorized

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

curl -X POST 'https://desk.texadesk.com/platform/api/v1/users' \ -H "api_access_token: $PLATFORM_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Daniel", "display_name": "Dan", "email": "[email protected]" }'

import os, requests headers = {"api_access_token": os.environ["PLATFORM_TOKEN"]} body = { "name": "Daniel", "display_name": "Dan", "email": "[email protected]" } r = requests.post("https://desk.texadesk.com/platform/api/v1/users", headers=headers, json=body) r.raise_for_status() print(r.json())

{ "id": 1.0, "access_token": "string", "account_id": 1.0, "available_name": "string", "avatar_url": "string", "confirmed": true, "display_name": "string", "message_signature": "string", "email": "string", "hmac_identifier": "string", "inviter_id": 1.0, "name": "string", "provider": "string", "pubsub_token": "string", "role": "agent", "ui_settings": {}, "uid": "string", "type": "string", "custom_attributes": {}, "accounts": [ { "id": 1.0, "name": "string", "status": "string", "active_at": "2026-10-19T10:00:00Z", "role": "administrator", "permissions": [ "string" ], "availability": "string", "availability_status": "string", "auto_offline": true, "custom_role_id": 1.0, "custom_role": {} } ] }