Please find the list of acceptable values for the country field here
POST https://services.leadconnectorhq.com/contacts/Authorization
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
Authorization | string | Yes | Bearer token generated from the Leadway portal. See Authentication. | |
Version | string | Yes | 2021-07-28 | API version. |
Body
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
firstName | string | No | Rosan | |
lastName | string | No | Deo | |
name | string | No | Rosan Deo | |
email | string | No | rosan@deos.com | |
locationId | string | Yes | ve9EPM428h8vShlRW1KT | |
gender | string | No | male | |
phone | string | No | +1 888-888-8888 | |
address1 | string | No | 3535 1st St N | |
city | string | No | Dolomite | |
state | string | No | AL | |
postalCode | string | No | 35061 | |
website | string | No | https://www.tesla.com | |
timezone | string | No | America/Chihuahua | |
dnd | boolean | No | 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)code(string)
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)
inboundDndSettings(object)all(object)status(string, required): Possible values: 'active', 'inactive'message(string)
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
tags | string[] | No | ||
customFields | object[] | No | ||
source | string | No | public api | |
dateOfBirth | object | No | 1990-09-25 | The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY |
country | string | No | US | |
companyName | string | No | DGS VolMAX | |
assignedTo | string | No | y0BeYjuRIlDwsDcOHOJo | User's Id |
Responses
201 - Successful response
contact(object)id(string): Example:seD4PfOuKoVMLkEZqohJdateAdded(string): Example:2021-08-31T09:59:41.937ZdateUpdated(string): Example:2021-08-31T09:59:41.937Zdeleted(boolean): Example:Falsetags(string[])type(string): Example:readcustomFields(object[])id(string): Example:MgobCB14YMVKuE4Ka8p1value(string): Example:name
locationId(string): Example:ve9EPM428h8vShlRW1KTfirstName(string): Example:rubikafirstNameLowerCase(string): Example:rubikafullNameLowerCase(string): Example:rubika deolastName(string): Example:DeolastNameLowerCase(string): Example:deoemail(string): Example:rubika@deos.comemailLowerCase(string): Example:rubika@deos.combounceEmail(boolean): Example:FalseunsubscribeEmail(boolean): Example:Falsednd(boolean): Example:TruedndSettings(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)code(string)
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)
phone(string): Example:+18832327657address1(string): Example:3535 1st St Ncity(string): Example:ruDolomitebikastate(string): Example:ALcountry(string): Example:USpostalCode(string): Example:35061website(string): Example:https://www.tesla.comsource(string): Example:public apicompanyName(string): Example:DGS VolMAXdateOfBirth(string): Example:Date format will be YYYY-MM-DDTHH:mm:ss.sssZ and Example 1990-09-25T00:00:00.000ZbirthMonth(number): Example:8birthDay(number): Example:25lastSessionActivityAt(string): Example:2021-07-16T11:39:30.564Zoffers(string[])products(string[])businessId(string): Example:641c094001436dbc2081e642assignedTo(string): User's Id Example:y0BeYjuRIlDwsDcOHOJo
{
"contact": {
"id": "seD4PfOuKoVMLkEZqohJ",
"dateAdded": "2021-08-31T09:59:41.937Z",
"dateUpdated": "2021-08-31T09:59:41.937Z",
"deleted": false,
"tags": [
"nisi sint commodo amet",
"consequat"
],
"type": "read",
"customFields": [
{
"id": "MgobCB14YMVKuE4Ka8p1",
"value": "name"
}
],
"locationId": "ve9EPM428h8vShlRW1KT",
"firstName": "rubika",
"firstNameLowerCase": "rubika",
"fullNameLowerCase": "rubika deo",
"lastName": "Deo",
"lastNameLowerCase": "deo",
"email": "rubika@deos.com",
"emailLowerCase": "rubika@deos.com",
"bounceEmail": false,
"unsubscribeEmail": false,
"dnd": true,
"dndSettings": {
"Call": {
"status": "active",
"message": "string",
"code": "string"
},
"Email": {
"status": "active",
"message": "string",
"code": "string"
},
// truncado: 40 lineas mas
}400 - Bad Request
{}422 - Unprocessable Entity
{}Example
curl -X POST 'https://services.leadconnectorhq.com/contacts/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"firstName": "Rosan",
"lastName": "Deo",
"name": "Rosan Deo",
"email": "rosan@deos.com",
"locationId": "ve9EPM428h8vShlRW1KT",
"gender": "male",
"phone": "+1 888-888-8888",
"address1": "3535 1st St N",
"city": "Dolomite",
"state": "AL",
"postalCode": "35061",
"website": "https://www.tesla.com",
"timezone": "America/Chihuahua",
"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"
}
},
"inboundDndSettings": {
"all": {
"status": "active",
"message": "string"
}
},
"tags": [
"nisi sint commodo amet",
"consequat"
],
"customFields": [],
"source": "public api",
"dateOfBirth": "1990-09-25",
"country": "US",
"companyName": "DGS VolMAX",
"assignedTo": "y0BeYjuRIlDwsDcOHOJo"
}'const response = await fetch('https://services.leadconnectorhq.com/contacts/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "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"}}, "inboundDndSettings": {"all": {"status": "active", "message": "string"}}, "tags": ["nisi sint commodo amet", "consequat"], "customFields": [], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo"}),
});
const data = await response.json();import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/contacts/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "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"}}, "inboundDndSettings": {"all": {"status": "active", "message": "string"}}, "tags": ["nisi sint commodo amet", "consequat"], "customFields": [], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo"},
)
data = response.json()<?php
$ch = curl_init('https://services.leadconnectorhq.com/contacts/');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'firstName': 'Rosan', 'lastName': 'Deo', 'name': 'Rosan Deo', 'email': 'rosan@deos.com', 'locationId': 've9EPM428h8vShlRW1KT', 'gender': 'male', 'phone': '+1 888-888-8888', 'address1': '3535 1st St N', 'city': 'Dolomite', 'state': 'AL', 'postalCode': '35061', 'website': 'https://www.tesla.com', 'timezone': 'America/Chihuahua', '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'}}, 'inboundDndSettings': {'all': {'status': 'active', 'message': 'string'}}, 'tags': ['nisi sint commodo amet', 'consequat'], 'customFields': [], 'source': 'public api', 'dateOfBirth': '1990-09-25', 'country': 'US', 'companyName': 'DGS VolMAX', 'assignedTo': 'y0BeYjuRIlDwsDcOHOJo'}),
]);
$data = json_decode(curl_exec($ch), true);