| Excerpt |
|---|
This method updates leads. A single lead can be updated by each call and only if it is not with status Won or Lost. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null. |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
| lead_identifier (mandatory) | Lead Identifier | The identifier of the Lead to be updated. The allowed lead identifier fields are the following:
| ||||||||
contact_email (optional) | String | The email address of the contact that will be specified on the updated lead | ||||||||
contact_phone (optional) | String | The phone of the contact that will be specified on the updated lead
| ||||||||
description (optional) | String | A description of the lead | ||||||||
probability_to_win (optional) | Number | The probability to win the retrieved lead which can vary from 0 to 100 | ||||||||
importance (optional) | Lead Importance | The importance related with the leads that should be returned as a result. The allowed lead importance fields are the following: IMPORTANCE1, IMPORTANCE2, IMPORTANCE3, IMPORTANCE4, IMPORTANCE5, CUSTOM1, CUSTOM2, CUSTOM3 | ||||||||
priority (optional) | Lead Priority | The priority related with the leads that should be returned as a result. The allowed lead priority fields are the following: 1, 2, 3, 4, 5, 6 | ||||||||
target_amount (optional) | Number | The amount that is predicted to be gained when winning the retrieved lead | ||||||||
status_identifier (optional) | Lead Status Identifier | The status of the lead. The allowed lead status identifier fields are the following:
| ||||||||
lost_reason_identifier (mandatory on conditions) | Lead Lost Reason Identifier | The reason that the lead was lost. This information is mandatory and applicable only if the lead is updated in a status classified as lost. The allowed lead lost reason identifier fields are the following:
| ||||||||
billing_address_identifier (mandatory on conditions) | Address identifier | The address that will be used as the accounts receivable billing address in case that the lead is updated to a status classified as won. This information is mandatory and applicable only if the lead is updated in a status classified as won. The allowed address identifier fields are the following:
| ||||||||
category_identifier (optional) | Lead Category Identifier | The category of the lead. The allowed lead category identifier fields are the following:
| ||||||||
owned_by_group_identifier | The identifier of the owned by group information | The owned by group information of the lead. The allowed group identifier fields are the following:
| ||||||||
privacy_level_identifier | The identifier of the privacy level | The privacy level of the lead. The allowed privacy level identifier fields are the following:
| ||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||
start_date | Date | The date that the lead started | ||||||||
expected_completion_date | Date | The date that the lead is expected to be completed. It is automatically calculated if estimate completion time is specified. | ||||||||
| estimated_completion_time (optional) | Time Period Object | The time that is estimated to complete the lead , measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified. | ||||||||
(optional) | Lead Source | Information related with the source of the lead | ||||||||
| assigned_to (optional) | Assigned to object | The assignment information for the lead | ||||||||
(optional) | Set of Lead Competitors | A lists of all possible competitors that can reach the same Lead for the same product/goal.
| ||||||||
(optional) | Set of Lead Users | A list of users that are set as the team involved with the lead
| ||||||||
(optional) | Set of lead Services Objects | A list of services for which the lead was taken for
| ||||||||
(optional) | Set of lead Physical Goods Objects | A list of the physical goods for which the lead was taken for
| ||||||||
(optional) | Set of lead Subscription Packages Objects | A list of the subscription packages for which the lead was taken for
| ||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...