Texa Desk Application API · Profile

Update user profile

PUT/api/v1/profile

Update the user profile details

Authorization

api_access_tokenheaderrequired

A person's access token (Texa Desk, Profile settings → Access token) or an agent bot's token, in the api_access_token header. It acts as that person, with their role's permissions.

Body application/json

profileobjectrequired

profile.namestring

profile.emailstring

profile.display_namestring

profile.message_signaturestring

profile.phone_numberstring

profile.current_passwordstring

profile.passwordstring

profile.password_confirmationstring

profile.ui_settingsobject

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

curl -X PUT 'https://desk.texadesk.com/api/v1/profile' \ -H "api_access_token: $TEXA_DESK_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "profile": { "name": "string", "email": "string", "display_name": "string", "message_signature": "string", "phone_number": "string", "current_password": "string", "password": "string", "password_confirmation": "string", "ui_settings": {} } }'

import os, requests headers = {"api_access_token": os.environ["TEXA_DESK_TOKEN"]} body = { "profile": { "name": "string", "email": "string", "display_name": "string", "message_signature": "string", "phone_number": "string", "current_password": "string", "password": "string", "password_confirmation": "string", "ui_settings": {} } } r = requests.put("https://desk.texadesk.com/api/v1/profile", 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": {} } ] }