Texa Desk Application API · Contacts

Update Contact

PUT/api/v1/accounts/{account_id}/contacts/{id}

Update a contact belonging to the account using ID

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.

Path parameters

account_idintegerrequired

The numeric ID of the account

idnumberrequired

ID of the contact

Body application/json

namestring

name of the contact

emailstring

email of the contact

blockedboolean

whether the contact is blocked or not

phone_numberstring

phone number of the contact

avatarstring (binary)

Send the form data with the avatar image binary or use the avatar_url

avatar_urlstring

The url to a jpeg, png file for the contact avatar

identifierstring

A unique identifier for the contact in external system

additional_attributesobject

An object where you can store additional attributes for contact. example {"type":"customer", "age":30}

custom_attributesobject

An object where you can store custom attributes for contact. example {"type":"customer", "age":30}, this should have a valid custom attribute definition.

Responses

204

Success

idnumber

payloadarray of object

payload[].additional_attributesobject

The object containing additional attributes related to the contact

payload[].availability_statusstring

The availability status of the contact

payload[].emailstring

The email address of the contact

payload[].idinteger

The ID of the contact

payload[].namestring

The name of the contact

payload[].phone_numberstring

The phone number of the contact

payload[].blockedboolean

Whether the contact is blocked

payload[].identifierstring

The identifier of the contact

payload[].thumbnailstring

The thumbnail of the contact

payload[].custom_attributesobject

The custom attributes of the contact

payload[].last_activity_atinteger

The last activity at of the contact

payload[].created_atinteger

The created at of the contact

payload[].contact_inboxesarray of object

payload[].contact_inboxes[].source_idstring

Contact Inbox Source Id

payload[].contact_inboxes[].inboxobject

404

Contact not found

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

403

Access denied

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

curl -X PUT 'https://desk.texadesk.com/api/v1/accounts/1/contacts/1' \ -H "api_access_token: $TEXA_DESK_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Alice", "email": "[email protected]", "blocked": false }'

import os, requests headers = {"api_access_token": os.environ["TEXA_DESK_TOKEN"]} body = { "name": "Alice", "email": "[email protected]", "blocked": False } r = requests.put("https://desk.texadesk.com/api/v1/accounts/1/contacts/1", headers=headers, json=body) r.raise_for_status() print(r.json())

{ "id": 1.0, "payload": [ { "additional_attributes": {}, "availability_status": "string", "email": "string", "id": 1, "name": "string", "phone_number": "string", "blocked": true, "identifier": "string", "thumbnail": "string", "custom_attributes": { "attribute_key": "attribute_value", "signed_up_at": "dd/mm/yyyy" }, "last_activity_at": 1, "created_at": 1, "contact_inboxes": [ { "source_id": null, "inbox": null } ] } ] }