Add or Update Lead

MT
Last updated 6 months ago

post
Add or Update Lead

[PlatformAddress]/api/1.0/contact?action=addOrUpdateLead
Add or update the details of a lead
Request
Response
Path Parameters
id
required
integer
The unique identifier of a lead (Leave empty to add the lead to the system)
qualityId
required
integer
The quality of the lead
industryId
optional
integer
The unique industry of the lead. (Required when lead belongs to contact and id parameter is missing)
sourceId
optional
integer
The unique source id of the lead. (Required when the id parameter is missing. )
companyId
optional
integer
The unique company id of lead. (Required when lead belongs to company and id parameter is missing)
companyLeadContactId
optional
integer
The unique company id of lead (Required when lead belongs to company and id parameter is missing)
contactId
optional
integer
The unique contact id of lead (Required when lead belongs to contact and id parameter is missing)
name
optional
string
The name for the lead (Required when the id parameter is missing)
ownerUserId
optional
integer
The sales person id of lead
typeId
optional
integer
The type of lead (Required when id parameter is missing)
stageId
optional
integer
The stage of lead (Required when id parameter is missing)
stageReasonId
optional
integer
The unique stage reason id of opportunity
channelId
optional
integer
The channel Id of lead
description
optional
string
The description for the lead
200: OK
‚Äč

Returns

Property

Description

success

Whether or not the lead was added to the account

id

The unique id of the lead

Throws

Code

Description

Specific Code: 24215

The request is empty

Specific Code: 24216

The lead does not exist

Specific Code: 24218

The lead details are invalid

This call takes values for a lead, and either

  1. Updates the values for that lead (after you have provided an id in the parameters), or

  2. Adds the lead to the system (if the id parameter is missing)

The result of this call will contain the status of the result (either true or false) and the lead identifier of the updated or newly created lead.