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.
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
locationId
stringExample:
ve9EPM428h8vShlRW1KT
gender
stringExample:
male
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
objectstatus
stringAllowed values:
activeinactivepermanent
message
stringcode
stringEmail
objectstatus
stringAllowed values:
activeinactivepermanent
message
stringcode
stringSMS
objectstatus
stringAllowed values:
activeinactivepermanent
message
stringcode
stringWhatsApp
objectstatus
stringAllowed values:
activeinactivepermanent
message
stringcode
stringGMB
objectstatus
stringAllowed values:
activeinactivepermanent
message
stringcode
stringFB
objectstatus
stringAllowed values:
activeinactivepermanent
message
stringcode
stringinboundDndSettings
objectall
objectstatus
stringAllowed values:
activeinactive
message
stringtags
array[string]Example:
["nisi sint commodo amet","consequat"]
customFields
id
stringExample:
6dvNaf7VhkQ9snc5vnjJ
key
stringExample:
my_custom_field
field_value
stringExample:
My Text
source
stringExample:
public api
country
stringExample:
US
companyName
string or null
Example:
DGS VolMAX
assignedTo
stringUser's Id
Example:
y0BeYjuRIlDwsDcOHOJo
Responses
200
Successful response
Body
contact
object
id
string
Example:
seD4PfOuKoVMLkEZqohJ
dateAdded
string
Example:
2021-08-31T09:59:41.937Z
dateUpdated
string
Example:
2021-08-31T09:59:41.937Z
deleted
boolean
Example:
false
tags
array[string]
Example:
["nisi sint commodo amet","consequat"]
type
string
Example:
read
customFields
array[object]
id
string
Example:
MgobCB14YMVKuE4Ka8p1
value
string
Example:
name
locationId
string
Example:
ve9EPM428h8vShlRW1KT
firstName
string
Example:
rubika
firstNameLowerCase
string
Example:
rubika
fullNameLowerCase
string
Example:
rubika deo
lastName
string
Example:
Deo
lastNameLowerCase
string
Example:
deo
email
string
Example:
rubika@deos.com
emailLowerCase
string
Example:
rubika@deos.com
bounceEmail
boolean
Example:
false
unsubscribeEmail
boolean
Example:
false
dnd
boolean
Example:
true
dndSettings
object
Call
object
status
string
Allowed values:
activeinactivepermanent
message
string
code
string
Email
object
status
string
Allowed values:
activeinactivepermanent
message
string
code
string
SMS
object
status
string
Allowed values:
activeinactivepermanent
message
string
code
string
WhatsApp
object
status
string
Allowed values:
activeinactivepermanent
message
string
code
string
GMB
object
status
string
Allowed values:
activeinactivepermanent
message
string
code
string
FB
object
status
string
Allowed values:
activeinactivepermanent
message
string
code
string
phone
string
Example:
+18832327657
address1
string
Example:
3535 1st St N
city
string
Example:
ruDolomitebika
state
string
Example:
AL
country
string
Example:
US
postalCode
string
Example:
35061
website
string
Example:
https://www.tesla.com
source
string
Example:
public api
companyName
string
Example:
DGS VolMAX
dateOfBirth
string
Example:
1990-09-25T00:00:00.000Z
birthMonth
number
Example:
8
birthDay
number
Example:
25
lastSessionActivityAt
string
Example:
2021-07-16T11:39:30.564Z
offers
array[string]
Example:
[]
products
array[string]
Example:
[]
businessId
string
Example:
641c094001436dbc2081e642
assignedTo
string
User's Id
Example:
y0BeYjuRIlDwsDcOHOJo
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