Please find the list of acceptable values for the country field here
Request
Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Provide your bearer token in the Authorization header when making requests to protected resources.
Path Parameters
contactId
stringContact Id
Example:
ocQHyuzHvysMo5N5VsXc
Headers
Authorization
stringAccess Token
Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
stringAPI Version
Allowed value:
2021-04-15
Body
firstName
string or null
Example:
rosan
lastName
string or null
Example:
Deo
name
string or null
Example:
rosan Deo
email
string or null
Example:
rosan@deos.com
phone
string or null
Example:
+1 888-888-8888
address1
string or null
Example:
3535 1st St N
city
string or null
Example:
Dolomite
state
string or null
Example:
AL
postalCode
stringExample:
35061
website
string or null
Example:
https://www.tesla.com
timezone
string or null
Example:
America/Chihuahua
dnd
booleanExample:
true
dndSettings
objectCall
objectEmail
objectSMS
objectWhatsApp
objectGMB
objectFB
objectinboundDndSettings
objectall
objecttags
array[string]This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.
Example:
["nisi sint commodo amet","consequat"]
customFields
id
stringExample:
6dvNaf7VhkQ9snc5vnjJ
key
stringExample:
my_custom_field
field_value
stringExample:
My Text
source
string or null
Example:
public api
country
stringExample:
US
assignedTo
string or null
User's Id
Example:
y0BeYjuRIlDwsDcOHOJo
Responses
200
Successful response
Body
succeded
booleanExample:
true
contact
objectid
stringExample:
seD4PfOuKoVMLkEZqohJ
name
stringExample:
rubika deo
locationId
stringExample:
ve9EPM428h8vShlRW1KT
firstName
stringExample:
rubika
lastName
stringExample:
Deo
email
stringExample:
rubika@deos.com
emailLowerCase
stringExample:
rubika@deos.com
timezone
stringExample:
companyName
stringExample:
DGS VolMAX
phone
stringExample:
+18832327657
dnd
booleanExample:
true
dndSettings
objecttype
stringExample:
read
source
stringExample:
public api
assignedTo
stringExample:
ve9EPM428h8vShlRW1KT
address1
stringExample:
3535 1st St N
city
stringExample:
ruDolomitebika
state
stringExample:
AL
country
stringExample:
US
postalCode
stringExample:
35061
website
stringExample:
https://www.tesla.com
tags
array[string]Example:
["nisi sint commodo amet","consequat"]
dateOfBirth
stringExample:
1990-09-25T00:00:00.000Z
dateAdded
stringExample:
2021-07-02T05:18:26.704Z
dateUpdated
stringExample:
2021-07-02T05:18:26.704Z
attachments
stringssn
stringkeyword
stringExample:
test
firstNameLowerCase
stringExample:
rubika
fullNameLowerCase
stringExample:
rubika deo
lastNameLowerCase
stringExample:
deo
lastActivity
stringExample:
2021-07-16T11:39:30.564Z
customFields
array[object]businessId
stringExample:
641c094001436dbc2081e642
attributionSource
objectlastAttributionSource
objectvisitorId
stringvisitorId is the Unique ID assigned to each Live chat visitor.
Example:
ve9EPM428h8vShlRW1KT
422
Unprocessable Entity
Body
statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
401
Unauthorized
Body
statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
400
Bad Request
Body
statusCode
number
Example:
400
message
string
Example:
Bad Request