Excerpt |
---|
This method creates a lead. Â Single lead can be created by each call. |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
contact_email
(mandatory on conditions)
...
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.
Tip |
---|
Paramerer is mandatory up until CRM.COM R11.0.0. From CRM.COM R11.1.0 this parameter is mandatory on conditions. |
...
contact_phone
(mandatory on conditions)
...
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.
Tip |
---|
Available from CRM.COM R11.1.0 |
...
accounts_receivable_identifier
(mandatory on conditions)
...
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)
...
probability_to_win
(optional)
...
importance
(mandatory)
...
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)
...
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)
...
type_identifier
(mandatory)
...
Excerpt |
---|
This method creates a lead. Â Single lead can be created by each call. |
Resource URL
Parameters
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
title | Example 1 |
---|
HTTP Method:Â POST
Â
Request:Â Â http://host_name/crmapi/rest/v2/leads/create
Body:
...
language | js |
---|
...
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) |
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:
Tip |
---|
The status_identifier input parameter is mandatory up until CRM.COM R11.1.0. From CRM.COM R11.1.0 it becomes optional. |
lost_reason_identifier
(mandatory on conditions)
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:
Tip |
---|
The lost_reason_identifier input parameter becomes deprecated from CRM.COM R11.1.0 |
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:
|
|
|
|
owned_by_group
| |
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:
|
|
|
|
|
udf_string_1Â
(optional)
User Defined Field of type String
udf_string_3Â
(optional)
User Defined Field of type String
| |
owned_by_group_identifier |
User Defined Field of type String
udf_string_5
(optional)
User Defined Field of type String
udf_string_6Â
(optional)
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 |
User Defined Field of type String
The identifier of the privacy level | The privacy level of the lead. The allowed privacy level identifier fields are the following:
| |||||||||
lead_owner | User Identifier | The user which owns the lead. The allowed user 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_ |
(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
(optional)
expected_completion_date
(semi-optional)
(semi-optional)
(mandatory)
(mandatory)
(optional)
(optional)
(optional)
(optional)
A list of services for which the lead was taken for
(optional)
A list of the physical goods for which the lead was taken for
(optional)
The subscription package for which the lead was taken for
Tip |
---|
Available from CRM.COM R14 |
fields_set
(optional)
...
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 Products Objects | A list of products for which the lead was taken for
| ||||
(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) | The Subscription Package Object | The subscription package 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 |
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
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.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
HTTP Method:Â POST Request:Â Â http://host_name/crmapi/rest/v2/leads/create Body:
Response:
 Response:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
HTTP Method:Â POST Request:Â {{server}}/crmapi/rest/v2/leads/create Body:
Response:
| ||||||||||
Expand | ||||||||||
| ||||||||||
HTTP Method:Â POST Â Request:Â {{server}}/crmapi/rest/v2/leads/create Body:
|
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
HTTP Method:Â POST Request:Â {{server}}/crmapi/rest/v2/leads/create Body:
Response:
|
...