| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| lead_identifier (mandatory) | Lead identifier | The identifier of the lead that should be returned as a result. The allowed lead identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| contact_information_identifier (semi-optional) | Contact information identifier | The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
| ||||||
type_identifier | Lead type identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (semi-optional) | Lead Category Identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (semi-optional) | Lead Source Identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
importance (semi-optional) | String | 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 (semi-optional) | String | 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 | ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
| ||||||
type_identifier | Lead type identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (optional) | Lead Category Identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (optional) | Lead Source Identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
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 | ||||||
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 |
...
GET leads/get_close_to_estimated_completion_time
| Tip |
|---|
Available from CRM.COM R11.1.0 |
This method returns all leads that are close to estimated completion time. Multiple leads are returned by each call. Note that identifiers are optional for this method.
Resource URL
Parameters
| Name | Type | Description | ||||||
| token | String | The token retrieved from the login method | ||||||
period | Number | The length of time for which a lead is close to estimated completion | ||||||
uot | String | The unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS | ||||||
contact_information_identifier (optional) | Contact Information Identifier | The identifier of the contact information for which the Lead was created. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the accounts receivable with which the lead is related to. The allowed accounts receivable identifier fields are the following:
| ||||||
type_identifier | Lead type identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (optional) | Lead category identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (semi-optional) | Lead source identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
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 | ||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||
|---|---|---|
| ||
HTTP Method: GET Request:{{server}}/crmapi/rest/v2/leads/get_close_to_estimated_completion_time?token={{token}}&period=3&uot=DAYS Response:
|
GET leads/get_pending
This method returns all leads which are in pending life cycle state. Multiple leads are returned by each call. Note that identifiers are optional for this method.
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
| ||||||
type_identifier | Lead type identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (optional) | Lead Category Identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (semi-optional) | Lead Source Identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
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 | ||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||
|---|---|---|---|---|---|
| |||||
HTTP Method: GET
Request: http://host_name/crmapi/rest/$version/leads/get_pending?token=A0D43A906975BF17402FDE34F29DE01C&contact_information_identifier=id_number=112233
Response:
|
GET leads/get_in_progress
This method returns all leads which are in life cycle state state "In Progress". Multiple leads are returned by each call. Note that identifiers are optional for this method.
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
| ||||||
type_identifier | Lead type identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (optional) | Lead Category Identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (semi-optional) | Lead Source Identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
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 | ||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||
|---|---|---|---|---|---|
| |||||
HTTP Method: GET
Request: http://host_name/crmapi/rest/$version/leads/get_in_progress?token=A0D43A906975BF17402FDE34F29DE01C&token=50666D82A7DB2E6E42F7C0C60EAC4695&type_identifier=name=Software Purchase Response:
|
GET leads/get_won_leads
| Tip |
|---|
Available from CRM.COM R11.1.0 |
This method returns all leads which are in life cycle state state "Won". Multiple leads are returned by each call. Note that identifiers are optional for this method.
Resource URL
Parameters
| Name | Type | Description | ||||||
| token | String | The token retrieved from the login method | ||||||
| contact_information_identifier (optional) | Contact Information Identifier | The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts Receivable Identifier | The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
| ||||||
| type_identifier (optional) | Lead Type Identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (optional) | Lead Category Identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (semi-optional) | Lead Source Identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
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 | ||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||
|---|---|---|
| ||
HTTP Method: GET Request: {{server}}/crmapi/rest/v2/leads/get_won_leads?token={{token}}&accounts_receivable_identifier=number=ACR0000000201&type_identifier=name=New Customer Response:
|
GET leads/get_lost_leads
| Tip |
|---|
Available from CRM.COM R11.1.0 |
This method returns all leads which are in life cycle state state "Lost". Multiple leads are returned by each call. Note that identifiers are optional for this method.
Resource URL
Parameters
| Name | Type | Description | ||||||
| token | String | The token retrieved from the login method | ||||||
| contact_information_identifier (optional) | Contact Information Identifier | The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts Receivable Identifier | The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
| ||||||
| type_identifier (optional) | Lead Type Identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (optional) | Lead Category Identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (semi-optional) | Lead Source Identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
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 | ||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||
|---|---|---|
| ||
HTTP Method: GET Request: {{server}}/crmapi/rest/v2/leads/get_lost_leads?token={{token}}&accounts_receivable_identifier=number=ACR0000000026&type_identifier=name=New Customer Response:
|
GET leads/get_cancelled
| Tip |
|---|
Available from CRM.COM R11.1.0 |
This method returns all leads which are in life cycle state state "Cancelled". Multiple leads are returned by each call. Note that identifiers are optional for this method.
Resource URL
Parameters
| Name | Type | Description | ||||||
| token | String | The token retrieved from the login method | ||||||
| contact_information_identifier (optional) | Contact Information Identifier | The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts Receivable Identifier | The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
| ||||||
| type_identifier (optional) | Lead Type Identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (optional) | Lead Category Identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (semi-optional) | Lead Source Identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
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 | ||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||
|---|---|---|
| ||
HTTP Method: GET Request: {{server}}/crmapi/rest/v2/leads/get_cancelled?token={{token}}&accounts_receivable_identifier=number=ACR0000000014&type_identifier=name=New Customer Response:
|
POST leads/create
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
contact_email (mandatory on conditions) | String | The email address of the contact that will be specified on the new lead. The contact email is mandatory if the Lead Type's Communication settings define that an email commuication will be sent on the new lead's creation.
| ||||||||
contact_phone (mandatory on conditions) | String | The phone of the contact that will be specified on the new lead. The contact phone is mandatory if the Lead Type's Communication settings define that a phone commuication will be sent on the new lead's creation.
| ||||||||
accounts_receivable_identifier (mandatory on conditions) | Accounts Receivable Identifier | The accounts receivable that will be related with the lead. This information is mandatory if the specified contact information is already a customer (has an accounts receivable). The specified accounts receivable should be owned by the specified contact information.The allowed accounts receivable identifier fields are the following:
| ||||||||
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 (mandatory) | 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 (mandatory) | 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 | ||||||||
type_identifier (mandatory) | Lead Type Identifier | The type of the lead. The allowed lead type identifier fields are the following:
| ||||||||
status_identifier (optional) | Lead Status Identifier | The status of the lead. If not specified, then the Lead Type's default status on create will be used. 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 created in a status classified as lost. The allowed lead lost reason identifier fields are the following:
| ||||||||
category_identifier (optional) | Lead Category Identifier | The category of the lead. If not specified, then the Lead Type's default Category will be used for the new 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 is created | ||||||||
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 (semi-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. | ||||||||
(mandatory) | Contact information object | The contact information that will be related with the lead | ||||||||
(mandatory) | Lead Source | Information related with the source of the lead | ||||||||
| assigned_to (optional) | Assigned to object | The assignment information for the lead. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules. | ||||||||
(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 | ||||||||
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 |
Anchor lead_create referred objects parameters lead_create referred objects parameters
Referred Parameter Objects Data
| lead_create referred objects parameters | |
| lead_create referred objects parameters |
...
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
| ||||||||
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 |
Anchor lead_updated referred objects parameters lead_updated referred objects parameters
Referred Parameter Objects Data
| lead_updated referred objects parameters | |
| lead_updated referred objects parameters |
...
POST leads/start_progress
| Tip |
|---|
Available from CRM.COM R11.1.0 |
This method starts the progress of a lead in Pending state. A single lead's progress can be started by each call
...
| Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
lead_identifier (mandatory) | Lead Identifier | The identifier of the lead that will be started. The allowed lead identifier fields are the following:
| ||||||
status_identifier (optional) | Lead Status Identifier | The status that will be set on the lead, after starting the progress. If not specified the the default status for starting leads of that type will be used. The allowed lead status identifiers are the following:
| ||||||
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 |
...
| Expand | ||||
|---|---|---|---|---|
| ||||
HTTP Method: POST
Request: {{server}}/crmapi/rest/v2/leads/start_progress Body:
Response:
|
POST leads/cancel
| Tip |
|---|
Available from CRM.COM R11.1.0 |
This method cancels a Lead but only as long as the Lead in not in life cycle state Won or Lost. A single lead can be cancelled by each call
...
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| token | String | The token retrieved from the login method | ||||||
lead_identifier (mandatory) | Lead Identifier | The identifier of the Lead to be cancelled. The allowed Lead identifier fields are the following:
| ||||||
status_identifier (optional) | Lead Status Identifier | The status that will be set on the Lead , after the cancellation. If not specified the the default status for cancelling Lead of that type will be used. The allowed Lead status identifiers are the following:
| ||||||
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 |
...
| Expand | ||||
|---|---|---|---|---|
| ||||
HTTP Method: POST
Request: {{server}}/crmapi/rest/v2/leads/cancel Body:
Response:
|
POST leads/win
| Tip |
|---|
Available from CRM.COM R11.1.0 |
This method marks a Lead as Won but only as long as the Lead is In Progress life cycle states. A single lead can be won by each call
...
| Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
lead_identifier (mandatory) | Lead Identifier | The identifier of the won Lead. The allowed lead identifier fields are the following:
| ||||||
status_identifier (optional) | Lead Status Identifier | The status that will be set on the Lead , after it is marked as Won. If not specified the the default status for winning a Lead of that type will be used. The allowed Lead status identifiers are the following:
| ||||||
(mandatory on conditions) | Accounts Receivable Object | The accounts receivable owned by the contact that identifies the CRM.COM customer, and handles all financial transactions that might be posted against it. This is required when the lead is won but only as long as the lead is not already related to an accounts receivable | ||||||
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 |
...
| Expand | ||||
|---|---|---|---|---|
| ||||
HTTP Method: POST
Request: {{server}}/crmapi/rest/v2/leads/win Body:
Response:
|
POST leads/lost
| Tip |
|---|
Available from CRM.COM R11.1.0 |
This method marks a Lead as Lost but only as long as the Lead is in Pending or In Progress life cycle states. A single lead can be marked as lost by each call
...
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| token | String | The token retrieved from the login method | ||||||
lead_identifier (mandatory) | Lead Identifier | The identifier of the won Lead. The allowed lead identifier fields are the following:
| ||||||
status_identifier (optional) | Lead Status Identifier | The status that will be set on the Lead , after it is marked as Lost. If not specified the the default status for loosing a Lead of that type will be used. The allowed Lead status identifiers are the following:
| ||||||
lost_reason_identifier (mandatory) | 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:
| ||||||
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 |
...