Contacts

Contact endpoints are meant to manage the contacts of the audience. A contact is a phone number in the audience having personal details that are valid only in the scope of the audience.

Method: Update

Operation updates the details of the contact

URL /v1/audiences/{audience_id}/contacts/{contact_id}
Method Type PUT
Authorization API Key
Request Content-Type JSON
Response Content-Type JSON

Headers

Name Type Description Status
X-Dexatel-Key string API key Required

Request Body

Name Type Description Status
data object

Details

(see data object below)
Optional
data object
Name Type Description Status
first_name string First name of the contact Optional
last_name string Last name of the contact Optional
timestamp string Timestamp value Optional
date string Date value to customize massages per contact Optional

Response Parameters

Name Type Description Status
data object

Details

(see data object below)
Optional
data object
Name Type Description Status
id string Unique identifier of the contact Optional
account_id string Unique identifier of the account Optional
audience_id string Unique identifier of the audience Optional
number string Phone number of the contact Optional
first_name string First name of the contact Optional
last_name string Last name of the contact Optional
timestamp string Timestamp value Optional
date string Date value to customize massages per contact Optional
create_date string Creation date of the contact in UTC, formatted as yyyyMM-dd HH:mm:ss Optional
update_date string Update date of the contact in UTC, formatted as yyyy-MMdd HH:mm:ss Optional
links object

Details

(see links object below)
Optional
links object
Name Type Description Status
self string URL of the contact Optional
account string URL of the account Optional
audience string URL of the audience Optional

Example of request body

PUT: /v1/audiences/22089fd7-7b74-4815-8452-3a8e864affbc/contacts/fe84f52d-d05e-4af6-b93a-08dc0110f536
X-Dexatel-Key: 94d2f2f2884848bca861264ad86d8ace
Content-Type: application/json

                
                        

Example of response body

status - 200

                
                        

Error Codes

The following error codes are returned in response to a user’s request which contains bad syntax or cannot be fulfilled.

Code Description
1351 Contact is not found
1352 Invalid contact identifier
1353 'data.number' is required
1354 'data.number' is invalid
1355 'data.number' is too long
1359 'data.tags' must be at most [10] items in length
1360 Contact already exists
1361 First name is too long
1362 Last name is too long
1363 Timestamp value is too long
1364 Date value is too long