Create or Update a Lead
Creates or updates a lead.
HTTP Request Examples
{
"leadId": 114065807,
"campaignId": 23505,
"ip": "",
"leadSource": "All Contacts",
"leadSourceId": "",
"points": 0,
"score": 0,
"leadStatus": "Active",
"leadOrigin": "Segment",
"leadOriginId": "21483",
"leadOriginName": "All Contacts",
"leadExtendedProperties": {},
"segments": [],
"leadUID": "27dbd702a45940d68a7d877394d5418e-114065807",
"Description": "",
"date_created": "2025-09-26T18:36:09.373",
"tenantId": 4647,
"dsId": "27dbd702a45940d68a7d877394d5418e",
"salutation": "",
"firstName": "",
"lastName": "",
"donotcontact": false,
"maxContactFrequencyInDays": 0,
"optOutEmail": false,
"optOutSms": false,
"optOutPush": false,
"optOutPhone": false,
"isPushEnabled": false,
"isWebPushEnabled": false,
"isSmsEnabled": true,
"isEmailEnabled": false,
"isEmailVerifiedForDelivery": false,
"isSMSVerified": false,
"fullname": "+18042916993",
"email": "",
"title": "",
"status": "Active",
"company": "",
"numberOfEmployees": 0,
"industry": 0,
"annualRevenue": 0,
"website": "",
"phone": "",
"mobilePhone": "+18042916993",
"homePhone": "",
"timezone": "",
"avatarPath": "",
"country": "",
"city": "",
"postalCode": "",
"address": "",
"geoCode": "",
"dateDoNotContactUntil": null,
"dateFirstSeen": "1753-01-01T00:00:00",
"dateLastSeen": "1753-01-01T00:00:00",
"region": "",
"gender": 0,
"dateBirth": null,
"age": 0,
"extendedProperties": {},
}
HTTP Request Parameters
leadidnumber
The numeric identifier for a lead to update. Do not include if this is a create.
campaignidnumber
The campaign id to add the lead to.
Creating a new lead
When creating a new lead a JSON object is POSTed to the API endpoint. While the lead object support many properties, creating a new lead is very simple. Creating a new lead requires the campaign id and either an email address or mobile phone number.
For example, creating a new lead with just an email address:
{
"campaignId":22226,
"email":"test@example.com"
}
Of course, additional details can be provided as well:
{
"campaignId":22226,
"firstName":"Chris",
"lastName":"Apple",
"email":"test@example.com",
"mobilePhone":"+15553610860"
}