Add or Update Lead

post
Add or Update Lead
[PlatformAddress]/api/1.0/contact?action=addOrUpdateLead
Add or update the details of a lead
Request
Response
Request
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)
company
optional
object
The data array of company. See addOrUpdateCompany API in contact namespace for parameters. See assigning a company/contact to the lead.
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)
contact
optional
object
The data array of contact. See addOrUpdateContact API in contact namespace for parameters. See assigning a company/contact to the lead.
name
optional
string
The name for the lead (Required when the id parameter is missing)
ownerUserId
optional
integer
The id of the sales person user assigned to the lead. The privileges of the user assigned to the api key may prevent this from being changed.
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
customFields
optional
array
The custom field values of the lead. A custom field value might be required depending on how it has been configured in the account. See Custom Field
Response
200: OK
​
Custom Field
A lead custom field is an object with the following details.
Property
Type
Required
Description
fieldId
integer
required
The unique id of the lead custom field
fieldValue
mixed
required
The value of the lead custom field. Depends on the type of custom field value.
Special Considerations
Assigning a company/contact to the lead
The contact type of a lead is either a company or a contact. When companyId or company is present in the request then the contact type of the lead is set to company, and the contactId or contact must be a contact that belongs to that company. Otherwise the contact type of the lead is set to contact and contactId can be any valid contact in the account.
If contact and company are present in request then it will link given contact to company.
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
Updates the values for that lead (after you have provided an id in the parameters), or
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.

Add or Update Company

Event

Last updated 3 months ago

Property	Type	Required	Description
fieldId	integer	required	The unique id of the lead custom field
fieldValue	mixed	required	The value of the lead custom field. Depends on the type of custom field value.

Property	Description
success	Whether or not the lead was added to the account
id	The unique id of the lead

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

Add or Update Lead

postAdd or Update Lead

Custom Field

Special Considerations

Assigning a company/contact to the lead

Returns

Throws

post
Add or Update Lead