| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET leads/show
This method returns information related with a lead. A single lead is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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
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
| Expand | |||||
|---|---|---|---|---|---|
| |||||
HTTP Method: GET
Request: http://host_name/crmapi/rest/v2/leads/show?token=6B6300203CBC420900E2B585934F682A&lead_identifier=number=19 Response:
|
GET leads/list
This method returns information related with leads. Multiple leads are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(semi-optional)
...
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:
...
(optional)
...
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
(semi-optional)
...
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)
...
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)
...
The identifier of the source lead. The allowed lead source identifier fields are the following:
...
importance
(semi-optional)
...
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)
...
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
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: GET
Request: http://host_name/crmapi/rest/v2/leads/list?token=DFBD9A73479EF55ED6C367F79B35844C&source_identifier=type=NOTIFICATIONS
Response:
| Code Block | ||
|---|---|---|
| ||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"actual_completion_date": "2015-02-17T12:26:35",
"services_set":
[
],
"target_amount": 130000,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "45",
"udf_float_4": null,
"competitors_set":
[
],
"udf_string_1": null,
"udf_string_2": null,
"assigned_to":
{
"unit": null,
"user":
{
"person_name": "security1",
"username": "security1",
"id": "C38C4EFC9DF12B6DDBF266E29FAEEFCE",
"email": null
}
},
"estimated_completion_time":
{
"time_period_value": 3,
"time_period_uot": "MONTHS"
},
"udf_string_3": null,
"contact_information":
{
"last_name": "Papadopoulou",
"life_cycle_state": "FINANCIAL",
"middle_name": "A",
"company_profile": null,
"title": "Miss",
"type": "PERSON",
"first_name": "Fiona",
"name": null,
"id": "F9D79DAD41EB6DC2E7E184170F0AA4DC",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"industry_sector": null,
"date_of_birth":
{
"month": 2,
"day": 2,
"year": 1978
},
"name_day":
{
"month": 11,
"day": 3
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"physical_goods_set":
[
],
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable": null,
"id": "F2D480CF016DBCBAF2E1982B30EEF03E",
"lead_source":
{
"type": "NOTIFICATIONS",
"notification":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Litt",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Mathew",
"name": null,
"id": "921C66776CBFEC5D839CA0DBFA1A1B76",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "111",
"social_security_number": "111",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "111",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "165",
"name": "Mathew Litt",
"id": "63755A788E078C16D506AD5CD1AB3E03"
},
"life_cycle_state": null,
"number": "52",
"id": "1918416EB3B3E94B8B451E3A008103B7",
"contact_information":
{
"last_name": "Litt",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Mathew",
"name": null,
"id": "921C66776CBFEC5D839CA0DBFA1A1B76",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "111",
"social_security_number": "111",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "111",
"id_issued_by_country": null,
"industry": null
}
}
}
},
"probability_to_win": 25,
"priority": 2,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"expected_completion_date": "2015-05-17T12:21:18",
"udf_date_4": null,
"start_date": "2015-02-17T12:21:18",
"users_set":
[
{
"id": "9B19252B3DE5BCE1BF5A9AC201780795",
"user":
{
"person_name": "v_kleanthous",
"username": "v_kleanthous",
"id": "FF7F0B0AED065136B0A7B0A883BF48E3",
"email": "v_kleanthous@crm.com"
}
},
{
"id": "716309D86FEC0F3CEED6692D496A0B39",
"user":
{
"person_name": "hannibal",
"username": "hannibal",
"id": "2C008EB82E0DBC7722E93F207E2091CE",
"email": "hannibal@crm.com"
}
}
],
"time_overdue":
{
"time_period_value": null,
"time_period_uot": null
},
"time_to_completion":
{
"time_period_value": null,
"time_period_uot": null
},
"owned_by_group":
{
"name": "Installation Group",
"id": "E2B8F8760CEDED45A64EF3CFCA3D1447",
"description": null,
"alternative_code": "IG"
},
"log_information":
{
"updated_date": "2015-02-17T12:26:38",
"created_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-02-17T12:21:18",
"updated_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
}
},
"status":
{
"name": "Won",
"id": "CE3D8565F49E82F5B7F3BB62C43A1B06",
"description": null,
"alternative_code": "WON"
},
"importance": "IMPORTANCE1",
"life_cycle_state": "WON",
"type":
{
"name": "Software Purchase",
"id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
"description": null,
"alternative_code": "SP"
},
"description": null,
"contact_email": "athina_mouxouri@crm.com",
"category":
{
"name": "Software Purchase",
"id": "C60F332D0B4CB8DD22A0159413951434",
"description": null,
"code": "SP"
},
"lost_reason": null
},
{
"actual_completion_date": "2015-02-17T16:53:07",
"services_set":
[
],
"target_amount": 22,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "56",
"udf_float_4": null,
"competitors_set":
[
],
"udf_string_1": null,
"udf_string_2": null,
"assigned_to":
{
"unit": null,
"user":
{
"person_name": "csmanager",
"username": "csmanager",
"id": "344BFEB717808669B0BF955212FEB28C",
"email": null
}
},
"estimated_completion_time":
{
"time_period_value": 3,
"time_period_uot": "MONTHS"
},
"udf_string_3": null,
"contact_information":
{
"last_name": "Charls",
"life_cycle_state": "MARKETING",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Fiona",
"name": null,
"id": "17A4A95031577305E0C7961979AE4765",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence": null,
"industry_sector": null,
"date_of_birth":
{
"month": 0,
"day": 0,
"year": 0
},
"name_day":
{
"month": null,
"day": null
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"physical_goods_set":
[
],
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable": null,
"id": "D99D83524F9B1E3AA354E56511CB7654",
"lead_source":
{
"type": "NOTIFICATIONS",
"notification":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou17",
"life_cycle_state": "FINANCIAL",
"middle_name": "P",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Marios",
"name": null,
"id": "D73AA349B9319CEF0C25351DF4C7DFF6",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "8788989",
"social_security_number": "8788980",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "8788988",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "95",
"name": "mar17",
"id": "F5235112A7A9FFFBF8C9AE7DA20CD7C4"
},
"life_cycle_state": null,
"number": "49",
"id": "6D9A7F80464B91DD5837AD3CE095ACC3",
"contact_information":
{
"last_name": "Ioannou17",
"life_cycle_state": "FINANCIAL",
"middle_name": "P",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Marios",
"name": null,
"id": "D73AA349B9319CEF0C25351DF4C7DFF6",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "8788989",
"social_security_number": "8788980",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "8788988",
"id_issued_by_country": null,
"industry": null
}
}
}
},
"probability_to_win": 12,
"priority": 2,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"expected_completion_date": "2015-05-17T16:52:50",
"udf_date_4": null,
"start_date": "2015-02-17T16:52:50",
"users_set":
[
],
"time_overdue":
{
"time_period_value": null,
"time_period_uot": null
},
"time_to_completion":
{
"time_period_value": null,
"time_period_uot": null
},
"owned_by_group":
{
"name": "GR0001",
"id": "492ACAF1A5B8F2F30AD80B517408720B",
"description": null,
"alternative_code": "GR0001"
},
"log_information":
{
"updated_date": "2015-02-17T16:53:40",
"created_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-02-17T16:52:50",
"updated_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
}
},
"status":
{
"name": "Won",
"id": "CE3D8565F49E82F5B7F3BB62C43A1B06",
"description": null,
"alternative_code": "WON"
},
"importance": "IMPORTANCE1",
"life_cycle_state": "WON",
"type":
{
"name": "Software Purchase",
"id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
"description": null,
"alternative_code": "SP"
},
"description": null,
"contact_email": "fiona@test.com",
"category":
{
"name": "Software Purchase",
"id": "C60F332D0B4CB8DD22A0159413951434",
"description": null,
"code": "SP"
},
"lost_reason": null
},
{
"actual_completion_date": null,
"services_set":
[
],
"target_amount": 1000,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "58",
"udf_float_4": null,
"competitors_set":
[
],
"udf_string_1": null,
"udf_string_2": null,
"assigned_to":
{
"unit": null,
"user":
{
"person_name": "Smanager",
"username": "Smanager",
"id": "DCA93D75753E5CC5AD1E69556368E616",
"email": null
}
},
"estimated_completion_time":
{
"time_period_value": 3,
"time_period_uot": "MONTHS"
},
"udf_string_3": null,
"contact_information":
{
"last_name": "Stevens",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Bebe",
"name": null,
"id": "813376B56DE985F0E53A3B73166B6E77",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": "50",
"social_security_number": "67",
"country_of_residence": null,
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "454545",
"id_issued_by_country": null,
"industry": null
}
},
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"physical_goods_set":
[
],
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Stevens",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Bebe",
"name": null,
"id": "813376B56DE985F0E53A3B73166B6E77",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": "50",
"social_security_number": "67",
"country_of_residence": null,
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "454545",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "536",
"name": "Bebe Stevens",
"id": "C1C8DE4718938D8495601D11E4412F73"
},
"id": "ED937A220239117FC4277B57B839530F",
"lead_source":
{
"type": "NOTIFICATIONS",
"notification":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou17",
"life_cycle_state": "FINANCIAL",
"middle_name": "P",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Marios",
"name": null,
"id": "D73AA349B9319CEF0C25351DF4C7DFF6",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "8788989",
"social_security_number": "8788980",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "8788988",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "95",
"name": "mar17",
"id": "F5235112A7A9FFFBF8C9AE7DA20CD7C4"
},
"life_cycle_state": null,
"number": "49",
"id": "6D9A7F80464B91DD5837AD3CE095ACC3",
"contact_information":
{
"last_name": "Ioannou17",
"life_cycle_state": "FINANCIAL",
"middle_name": "P",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Marios",
"name": null,
"id": "D73AA349B9319CEF0C25351DF4C7DFF6",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "8788989",
"social_security_number": "8788980",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "8788988",
"id_issued_by_country": null,
"industry": null
}
}
}
},
"probability_to_win": 54,
"priority": 2,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"expected_completion_date": "2015-05-17T17:00:08",
"udf_date_4": null,
"start_date": "2015-02-17T17:00:08",
"users_set":
[
],
"time_overdue":
{
"time_period_value": null,
"time_period_uot": null
},
"time_to_completion":
{
"time_period_value": null,
"time_period_uot": null
},
"owned_by_group":
{
"name": "Main Group",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"description": "Main Group",
"alternative_code": "das"
},
"log_information":
{
"updated_date": "2015-02-18T14:18:18",
"created_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-02-17T17:00:08",
"updated_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
}
},
"status":
{
"name": "Won",
"id": "CE3D8565F49E82F5B7F3BB62C43A1B06",
"description": null,
"alternative_code": "WON"
},
"importance": "IMPORTANCE1",
"life_cycle_state": "WON",
"type":
{
"name": "Software Purchase",
"id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
"description": null,
"alternative_code": "SP"
},
"description": null,
"contact_email": "bbs@crm.com",
"category":
{
"name": "Software Purchase",
"id": "C60F332D0B4CB8DD22A0159413951434",
"description": null,
"code": "SP"
},
"lost_reason": null
},
{
"actual_completion_date": "2015-03-11T11:17:36",
"services_set":
[
],
"target_amount": 1000,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "67",
"udf_float_4": null,
"competitors_set":
[
],
"udf_string_1": null,
"udf_string_2": null,
"assigned_to":
{
"unit":
{
"name": "Developers Unit",
"id": "C4370788B2630BC8A99E8C7397406C09",
"description": null,
"alternative_code": null
},
"user":
{
"person_name": "supervisor",
"username": "supervisor",
"id": "018CA08BC267612F6206D85011FFC5D1"
}
},
"estimated_completion_time":
{
"time_period_value": 10,
"time_period_uot": "DAYS"
},
"udf_string_3": null,
"contact_information":
{
"last_name": "Xenon",
"life_cycle_state": "MARKETING",
"middle_name": "A.",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Costas",
"name": null,
"id": "1ADB6164F933E381CF65B7F6E7705B8B",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"industry_sector": null,
"date_of_birth":
{
"month": 9,
"day": 30,
"year": 1977
},
"name_day":
{
"month": 5,
"day": 1
},
"id_number": "999999",
"id_issued_by_country": null,
"industry": null
}
},
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"physical_goods_set":
[
],
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable": null,
"id": "F75F88397C0849F5B53A010AD3091538",
"lead_source":
{
"type": "NOTIFICATIONS",
"notification":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Litt",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Mathew",
"name": null,
"id": "921C66776CBFEC5D839CA0DBFA1A1B76",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "111",
"social_security_number": "111",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "111",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "165",
"name": "Mathew Litt",
"id": "63755A788E078C16D506AD5CD1AB3E03"
},
"life_cycle_state": null,
"number": "51",
"id": "49B37FA3E001C43F28CFEAFEB3E451D5",
"contact_information":
{
"last_name": "Litt",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Mathew",
"name": null,
"id": "921C66776CBFEC5D839CA0DBFA1A1B76",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "111",
"social_security_number": "111",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "111",
"id_issued_by_country": null,
"industry": null
}
}
}
},
"probability_to_win": 50,
"priority": 1,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"expected_completion_date": "2015-03-21T11:16:28",
"udf_date_4": null,
"start_date": "2015-03-11T11:16:28",
"users_set":
[
],
"time_overdue":
{
"time_period_value": null,
"time_period_uot": null
},
"time_to_completion":
{
"time_period_value": null,
"time_period_uot": null
},
"owned_by_group":
{
"name": "First Digital",
"id": "C99587F08621440FADB06E8FA5C0B23B",
"description": null,
"alternative_code": "FD"
},
"log_information":
{
"updated_date": "2015-03-11T11:17:43",
"created_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-03-11T11:16:28",
"updated_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
}
},
"status":
{
"name": "Lost",
"id": "157C9060CB0F75EC2DCA62D16B5897EE",
"description": null,
"alternative_code": "LOST"
},
"importance": "IMPORTANCE1",
"life_cycle_state": "LOST",
"type":
{
"name": "New Type",
"id": "03C4E24BAAE74D0CA071560C7B663C7E",
"description": null,
"alternative_code": "NT"
},
"description": null,
"contact_email": "cxenon@crm.com",
"category":
{
"name": "New Category",
"id": "0B0A6FF02D0D48188F266BB4035AC41C",
"description": null,
"code": "NC"
},
"lost_reason": null
},
{
"actual_completion_date": null,
"services_set":
[
],
"target_amount": 100,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "68",
"udf_float_4": null,
"competitors_set":
[
{
"id": "E2394E02073847ED9633C88D90E94BDE",
"competitor":
{
"website": "www.competitor1.com",
"name": "Competitor 1",
"id": "C671ED66046243565DE5B6B4A1AB5835",
"description": null
}
}
],
"udf_string_1": null,
"udf_string_2": null,
"assigned_to":
{
"unit":
{
"name": "Developers Unit",
"id": "C4370788B2630BC8A99E8C7397406C09",
"description": null,
"alternative_code": null
},
"user":
{
"person_name": "supervisor",
"username": "supervisor",
"id": "018CA08BC267612F6206D85011FFC5D1"
}
},
"estimated_completion_time":
{
"time_period_value": 3,
"time_period_uot": "MONTHS"
},
"udf_string_3": null,
"contact_information":
{
"last_name": null,
"life_cycle_state": "MARKETING",
"middle_name": null,
"company_profile":
{
"tax_reference_number": null,
"annual_turnover": null,
"number_of_employees": null,
"profile_year": null,
"established_date": null,
"industry_sector": null,
"registered_in_country": null,
"vat_registration_number": null,
"industry": null,
"vat_registration_date": null,
"vat_registered_by": null,
"registration_number": null
},
"title": null,
"type": "COMPANY",
"first_name": null,
"name": null,
"id": "D9C7C7587CEA4EA09198FA8FBB0313D5",
"company_name": "company lead",
"demographics": null
},
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"physical_goods_set":
[
{
"product_type": null,
"id": "476D03E0AE56421A92A933312DA1E80D",
"product":
{
"product_type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Distribution Services",
"id": "65EB098619B362EBCF361755602832E1",
"description": "BAS, Sobetel, Service for Twin 1, Twin 2, Twin 3 PT1, PT2 PT3",
"alternative_code": "DSTR SRV"
},
"id": "7025D20E1AEE61C7ECB87021D32E9EF3",
"description": "Card product",
"code": "Card product 001",
"alternative_code": "CP001"
}
},
{
"product_type": null,
"id": "C47D92FA80C14975B4CD39D041A2656D",
"product":
{
"product_type":
{
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Distribution Services",
"id": "65EB098619B362EBCF361755602832E1",
"description": "BAS, Sobetel, Service for Twin 1, Twin 2, Twin 3 PT1, PT2 PT3",
"alternative_code": "DSTR SRV"
},
"id": "F7CEEAAFCE2519EDBD207755588F34F9",
"description": "Card product 003",
"code": "Card Product 003",
"alternative_code": "CP003"
}
}
],
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable": null,
"id": "13B20570DFD14C4492932143EC2FAEF6",
"lead_source":
{
"type": "NOTIFICATIONS",
"notification":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou17",
"life_cycle_state": "FINANCIAL",
"middle_name": "P",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Marios",
"name": null,
"id": "D73AA349B9319CEF0C25351DF4C7DFF6",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "8788989",
"social_security_number": "8788980",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "8788988",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "95",
"name": "mar17",
"id": "F5235112A7A9FFFBF8C9AE7DA20CD7C4"
},
"life_cycle_state": null,
"number": "49",
"id": "6D9A7F80464B91DD5837AD3CE095ACC3",
"contact_information":
{
"last_name": "Ioannou17",
"life_cycle_state": "FINANCIAL",
"middle_name": "P",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Marios",
"name": null,
"id": "D73AA349B9319CEF0C25351DF4C7DFF6",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "8788989",
"social_security_number": "8788980",
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "8788988",
"id_issued_by_country": null,
"industry": null
}
}
}
},
"probability_to_win": 90,
"priority": 2,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"expected_completion_date": "2015-06-11T13:06:10",
"udf_date_4": null,
"start_date": "2015-03-11T13:06:10",
"users_set":
[
{
"id": "59D971EF8CD2455B934382261AF9A50C",
"user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1",
"email": "mp@ministrator.com"
}
}
],
"time_overdue":
{
"time_period_value": null,
"time_period_uot": null
},
"time_to_completion":
{
"time_period_value": 2.946236559139785,
"time_period_uot": "MONTHS"
},
"owned_by_group":
{
"name": "Main Group",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"description": "Main Group",
"alternative_code": "das"
},
"log_information":
{
"updated_date": "2015-03-11T14:07:46",
"created_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-03-11T13:06:10",
"updated_by_unit":
{
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "mpadministrator",
"username": "mpadministrator",
"id": "1"
}
},
"status":
{
"name": "Reach",
"id": "5DA88E4C781244C2CDB0F4F57E2EE875",
"description": null,
"alternative_code": "R"
},
"importance": "IMPORTANCE1",
"life_cycle_state": "PENDING",
"type":
{
"name": "Software Purchase",
"id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
"description": null,
"alternative_code": "SP"
},
"description": null,
"contact_email": "cl@crm.com",
"category":
{
"name": "Software Purchase",
"id": "C60F332D0B4CB8DD22A0159413951434",
"description": null,
"code": "SP"
},
"lost_reason": null
}
]
}
|
GET leads/get_overdue
This method returns all leads which are not completed and are past their expected 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
...
(optional)
...
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:
...
(optional)
...
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)
...
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)
...
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)
...
The identifier of the source lead. The allowed lead source identifier fields are the following:
...
importance
(optional)
...
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)
...
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
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
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
...
Examples
| Expand | |||||
|---|---|---|---|---|---|
| |||||
HTTP Method: GET
Request: http://host_name/crmapi/rest/v2/leads/get_overdue?token=8308DBB946F992DF90863872E1AD5391&type_identifier=name=Software Purchase Response:
|
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
...
String
...
The token retrieved from the login method
...
period
(mandatory)
...
uot
(mandatory)
...
MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS
...
contact_information_identifier
(optional)
...
The identifier of the contact information for which the Lead was created. The allowed contact information identifier fields are the following:
...
...
(optional)
...
The identifier of the accounts receivable with which the lead is related to. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
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)
...
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)
...
The identifier of the source lead. The allowed lead source identifier fields are the following:
...
importance
(optional)
...
priority
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
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
| 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
...
(optional)
...
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:
...
(optional)
...
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)
...
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)
...
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)
...
The identifier of the source lead. The allowed lead source identifier fields are the following:
...
importance
(optional)
...
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)
...
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
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
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
...
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
...
(optional)
...
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:
...
(optional)
...
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)
...
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)
...
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)
...
The identifier of the source lead. The allowed lead source identifier fields are the following:
...
importance
(optional)
...
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)
...
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
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
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
...
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
...
(optional)
...
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:
...
(optional)
...
The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
...
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)
...
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)
...
The identifier of the source lead. The allowed lead source identifier fields are the following:
...
importance
(optional)
...
priority
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
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
| 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
...
(optional)
...
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:
...
(optional)
...
The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
...
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)
...
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)
...
The identifier of the source lead. The allowed lead source identifier fields are the following:
...
importance
(optional)
...
priority
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
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
| 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
...
(optional)
...
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:
...
(optional)
...
The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
...
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)
...
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)
...
The identifier of the source lead. The allowed lead source identifier fields are the following:
...
importance
(optional)
...
priority
(optional)
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
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
| 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
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)
...
The type of the lead. The allowed lead type identifier fields are the following:
...
status_identifier
(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 |
...
category_identifier
(optional)
...
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:
...
| Tip |
|---|
The category_identifier input parameter is mandatory up until CRM.COM R11.1.0 |
...
owned_by_group_identifier
(optional)
...
The owned by group information of the lead. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the lead. The allowed privacy level identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
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
(optional)
...
expected_completion_date
(semi-optional)
...
(mandatory)
...
(mandatory)
...
(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
...
fields_set
(optional)
...
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
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
HTTP Method: POST
Request: http://host_name/crmapi/rest/v2/leads/create Body:
Response:
|
POST leads/update
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.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
The identifier of the Lead to be updated. The allowed lead identifier fields are the following:
...
contact_email
(optional)
...
contact_phone
(optional)
...
The phone of the contact that will be specified on the updated lead
| Tip |
|---|
Available from CRM.COM R11.1.0 |
...
description
(optional)
...
probability_to_win
(optional)
...
importance
(optional)
...
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)
...
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)
...
status_identifier
(optional)
...
The status of the lead. The allowed lead status identifier fields are the following:
...
lost_reason_identifier
(mandatory on conditions)
...
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:
...
| Tip |
|---|
Deprecated from CRM.COM R11.1.0 |
...
billing_address_identifier
(mandatory on conditions)
...
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:
...
| Tip |
|---|
Deprecated from CRM.COM R11.1.0. |
...
category_identifier
(optional)
...
The category of the lead. The allowed lead category identifier fields are the following:
...
owned_by_group_identifier
(optional)
...
The owned by group information of the lead. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the lead. The allowed privacy level identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
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
(optional)
...
expected_completion_date
(optional)
...
(optional)
...
(optional)
...
A lists of all possible competitors that can reach the same Lead for the same product/goal.
...
(optional)
...
A list of users that are set as the team involved with the lead
...
(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
...
fields_set
(optional)
...
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
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
HTTP Method: POST
Request: http://host_name/crmapi/rest/v2/leads/update Body:
Response:
|
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
Resource URL
Parameters
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
lead_identifier
(mandatory)
...
The identifier of the lead that will be started. The allowed lead identifier fields are the following:
...
status_identifier
(optional)
...
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)
...
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
...
Examples
| 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
Resource
Parameters
...
String
...
The token retrieved from the login method
...
lead_identifier
(mandatory)
...
The identifier of the Lead to be cancelled. The allowed Lead identifier fields are the following:
...
status_identifier
(optional)
...
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)
...
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
...
Examples
| 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
Resource
Parameters
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
lead_identifier
(mandatory)
...
The identifier of the won Lead. The allowed lead identifier fields are the following:
...
status_identifier
(optional)
...
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)
...
fields_set
(optional)
...
List of Strings, comma separated
...
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
| 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
Resource
Parameters
...
lead_identifier
(mandatory)
...
The identifier of the won Lead. The allowed lead identifier fields are the following:
...
status_identifier
(optional)
...
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
...
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
| Expand | ||||
|---|---|---|---|---|
|
| Code Block |
|---|
{
"token":"{{token}}",
"lead_identifier":{"number":"44"},
"lost_reason_identifier":{"name":"Competitors"}
} |
Response:
| name | blue |
|---|
| Child pages (Children Display) | ||
|---|---|---|
|