GrowthHub API 2.0
Country List
Select country code whenever a contact will create or update with country field
| Country Code | Country Name |
|---|
APPLICATION/JSON
SCHEMA
contact object
id string
Example:seD4PfOuKoVMLkEZqohJ
name string
Example:rubika deo
locationId string
Example:ve9EPM428h8vShlRW1KT
firstName string
Example:rubika
lastName string
Example:Deo
email string
Example:[email protected]
emailLowerCase string
Example:[email protected]
timezone string
Example:Asia/Calcutta
companyName string
Example:DGS VolMAX
phone string
Example:+18832327657
dnd boolean
Example:true
dndSettings object
- Call object
status string required
Possible values: [active, inactive, permanent]
message string
code string
- Email object
status string required
Possible values: [active, inactive, permanent]
message string
codes tring
- SMS object
status string required
Possible values: [active, inactive, permanent]
message string
code string
- WhatsApp object
status string required
Possible values: [active, inactive, permanent]
message string
code string
- GMB object
status string required
Possible values: [active, inactive, permanent]
message string
code string
- FB object
status string required
Possible values: [active, inactive, permanent]
message string
code string
type string
Example:read
source string
Example:public api
assignedTo string
Example:ve9EPM428h8vShlRW1KT
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
tags string[]
Example:["nisi sint commodo amet","consequat"]
dateOfBirth string
Example:Date format YYYY-MM-DD
dateAdded string
Example:2021-07-02T05:18:26.704Z
dateUpdated string
Example:2021-07-02T05:18:26.704Z
attachments string
ssn string
keyword string
Example:test
firstNameLowerCase string
Example:rubika
fullNameLowerCase string
Example:rubika deo
lastNameLowerCase string
Example:deo
lastActivity string
Example:2021-07-16T11:39:30.564Z
customFields object[]
- Array [
id string
Example:MgobCB14YMVKuE4Ka8p1
valuestringExample:name
businessId string
Example:641c094001436dbc2081e642
attributionSource object
- url string required
Example:Trigger Link
campaign string - nullable
utmSource string - nullable
utmMedium string - nullable
utmContent string - nullable
referrer string - nullable
Example:https: //www.google.com
campaignId string - nullable
fbclid string - nullable
gclid string - nullable
Example:CjOKCQjwnNyUBhCZARISAI9AYIFtNnIcWcYGIOQINz_ZoFI5SSLRRugSoPZoiEu27IZBY£1-MAIWmEaAo2VEALW_WCB
msclikid string - nullable
dclid string - nullable
fbc string - nullable
fbp string - nullable
Example:fb. 1.1674748390986.1171287961
fbEventId string - nullable
Example:Mozilla/5.0
userAgent string - nullable
Example:Mozilla/5.0
ip string - nullable
Example:58.111.106.198
medium string - nullable
Example:survey
mediumId string - nullable
Example:FglfHAn30PRwsZVyQlKp
lastAttributionSource object
- url string required
Example:Trigger Link
campaign string - nullable
utmSource string - nullable
utmMedium string - nullable
utmContent string - nullable
referrer string - nullable
Example:https: //www.google.com
campaignId string - nullable
fbclid string - nullable
gclid string - nullable
Example:CjOKCQjwnNyUBhCZARISAI9AYIFtNnIcWcYGIOQINz_ZoFI5SSLRRugSoPZoiEu27IZBY£1-MAIWmEaAo2VEALW_WCB
msclikid string - nullable
dclid string - nullable
fbc string - nullable
fbp string - nullable
Example:fb. 1.1674748390986.1171287961
fbEventId string - nullable
Example:Mozilla/5.0
userAgent string - nullable
Example:Mozilla/5.0
ip string - nullable
Example:58.111.106.198
medium string - nullable
Example:survey
mediumId string - nullable
Example:FglfHAn30PRwsZVyQlKp
visitorId string
visitorId is the Unique ID assigned to each Live chat visitor.
Example:ve9EPM428h8vShlRW1KT
EXAMPLE (auto)
{
"contact": {
"id": "seD4PfOuKoVMLkEZqohJ",
"name": "rubika deo",
"locationId": "ve9EPM428h8vShlRW1KT",
"firstName": "rubika",
"lastName": "Deo",
"email": "[email protected]",
"emailLowerCase": "[email protected]",
"timezone": "Asia/Calcutta",
"companyName": "DGS VolMAX",
"phone": "+18832327657",
"dnd": true,
"dndSettings": {
"Call": {
"status": "active",
"message": "string",
"code": "string"
},
"Email": {
"status": "active",
"message": "string",
"code": "string"
},
"SMS": {
"status": "active",
"message": "string",
"code": "string"
},
"WhatsApp": {
"status": "active",
"message": "string",
"code": "string"
},
"GMB": {
"status": "active",
"message": "string",
"code": "string"
},
"FB": {
"status": "active",
"message": "string",
"code": "string"
}
},
"type": "read",
"source": "public api",
"assignedTo": "ve9EPM428h8vShlRW1KT",
"address1": "3535 1st St N",
"city": "ruDolomitebika",
"state": "AL",
"country": "US",
"postalCode": "35061",
"website": "https://www.tesla.com",
"tags": [
"nisi sint commodo amet",
"consequat"
],
"dateOfBirth": "Date format YYYY-MM-DD",
"dateAdded": "2021-07-02T05:18:26.704Z",
"dateUpdated": "2021-07-02T05:18:26.704Z",
"attachments": "string",
"ssn": "string",
"keyword": "test",
"firstNameLowerCase": "rubika",
"fullNameLowerCase": "rubika deo",
"lastNameLowerCase": "deo",
"lastActivity": "2021-07-16T11:39:30.564Z",
"customFields": [
{
"id": "MgobCB14YMVKuE4Ka8p1",
"value": "name"
}
],
"businessId": "641c094001436dbc2081e642",
"attributionSource": {
"url": "Trigger Link",
"campaign": "string",
"utmSource": "string",
"utmMedium": "string",
"utmContent": "string",
"referrer": "https: //www.google.com",
"campaignId": "string",
"fbclid": "string",
"gclid": "CjOKCQjwnNyUBhCZARISAI9AYIFtNnIcWcYGIOQINz_ZoFI5SSLRRugSoPZoiEu27IZBY£1-MAIWmEaAo2VEALW_WCB",
"msclikid": "string",
"dclid": "string",
"fbc": "string",
"fbp": "fb. 1.1674748390986.1171287961",
"fbEventId": "Mozilla/5.0",
"userAgent": "Mozilla/5.0",
"ip": "58.111.106.198",
"medium": "survey",
"mediumId": "FglfHAn30PRwsZVyQlKp"
},
"lastAttributionSource": {
"url": "Trigger Link",
"campaign": "string",
"utmSource": "string",
"utmMedium": "string",
"utmContent": "string",
"referrer": "https: //www.google.com",
"campaignId": "string",
"fbclid": "string",
"gclid": "CjOKCQjwnNyUBhCZARISAI9AYIFtNnIcWcYGIOQINz_ZoFI5SSLRRugSoPZoiEu27IZBY£1-MAIWmEaAo2VEALW_WCB",
"msclikid": "string",
"dclid": "string",
"fbc": "string",
"fbp": "fb. 1.1674748390986.1171287961",
"fbEventId": "Mozilla/5.0",
"userAgent": "Mozilla/5.0",
"ip": "58.111.106.198",
"medium": "survey",
"mediumId": "FglfHAn30PRwsZVyQlKp"
},
"visitorId": "ve9EPM428h8vShlRW1KT"
}
}
APPLICATION/JSON
SCHEMA
statusCode number
Example:400
message string
Example:Bad Request
EXAMPLE (auto)
{
"statusCode": 400,
"message": "Bad Request"
}
APPLICATION/JSON
SCHEMA
statusCode number
Example:401
message string
Example:Invalid token: access token is invalid
error string
Example:Unauthorized
EXAMPLE (auto)
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
APPLICATION/JSON
SCHEMA
statusCode number
Example:422
message string[]
Example:["Unprocessable Entity"]
error string
Example:Unprocessable Entity
EXAMPLE (auto)
{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}