add-or-update-lead.md

Add or Update Lead

{% api-method method="post" host="[PlatformAddress]/api/1.0/contact?action=addOrUpdateLead" path="" %} {% api-method-summary %} Add or Update Lead {% endapi-method-summary %}

{% api-method-description %} Add or update the details of a lead {% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-path-parameters %} {% api-method-parameter name="id" type="integer" required=true %} The unique identifier of a lead
(Leave empty to add the lead to the system) {% endapi-method-parameter %}

{% api-method-parameter name="qualityId" type="integer" required=true %} The quality of the lead {% endapi-method-parameter %}

{% api-method-parameter name="industryId" type="integer" required=false %} The unique industry of the lead.
(Required when lead belongs to contact and id parameter is missing) {% endapi-method-parameter %}

{% api-method-parameter name="sourceId" type="integer" required=false %} The unique source id of the lead.
(Required when the id parameter is missing. ) {% endapi-method-parameter %}

{% api-method-parameter name="companyId" type="integer" required=false %} The unique company id of lead.
(Required when lead belongs to company and id parameter is missing) {% endapi-method-parameter %}

{% api-method-parameter name="companyLeadContactId" type="integer" required=false %} The unique company id of lead
(Required when lead belongs to company and id parameter is missing) {% endapi-method-parameter %}

{% api-method-parameter name="contactId" type="integer" required=false %} The unique contact id of lead
(Required when lead belongs to contact and id parameter is missing) {% endapi-method-parameter %}

{% api-method-parameter name="name" type="string" required=false %} The name for the lead
(Required when the id parameter is missing) {% endapi-method-parameter %}

{% api-method-parameter name="ownerUserId" type="integer" required=false %} The sales person id of lead {% endapi-method-parameter %}

{% api-method-parameter name="typeId" type="integer" required=false %} The type of lead
(Required when id parameter is missing) {% endapi-method-parameter %}

{% api-method-parameter name="stageId" type="integer" required=false %} The stage of lead
(Required when id parameter is missing) {% endapi-method-parameter %}

{% api-method-parameter name="stageReasonId" type="integer" required=false %} The unique stage reason id of opportunity {% endapi-method-parameter %}

{% api-method-parameter name="channelId" type="integer" required=false %} The channel Id of lead {% endapi-method-parameter %}

{% api-method-parameter name="description" type="string" required=false %} The description for the lead {% endapi-method-parameter %} {% endapi-method-path-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

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.