Available from CRM.COM R9.0.0
GET leads/configuration/types/list
This method returns the lead types that are allowed to be used in the system as these are defined in active Lead Definitions. Multiple lead types are returned by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be providing the lead type. The group is filtered against the lead types' allowed organisational units. The allowed group identifier fields are the following:
| ||||||||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be providing the lead type. The unit is filtered against the lead types' allowed organisational units. The allowed unit 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead type |
name | String | The name of the retrieved lead type |
alternative_code | String | The alternative code of the retrieved lead type |
| description | String | A description of the retrieved lead type |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| log_information | Log Information Object | The log information of the retrieved lead type |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"id": "02B85B002C97441BB7EF6E57FF8E3EE8",
"name": "On Premise Software Purchase",
"alternative_code": "OPSP"
},
{
"id": "32852CA161DD44A099A072A317BC0D68",
"name": "New Subscribers",
"alternative_code": "NS"
}
GET leads/configuration/statuses/list
This method returns the statuses that are allowed to be used by leads of specific type. Multiple statuses are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
lead_type_identifier (mandatory) | Lead Type Identifier | The identifier of the type of the lead that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. The allowed lead type identifier fields are the following:
| ||||||||||||
life_cycle_state (optional) | Sting | The life cycle state that the status should have. If specified then only statuses related with the specified life cycle state will be retrieved. Life cycle state options are: PENDING, IN PROGRESS, LOST and WON | ||||||||||||
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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead type status |
| status | Lead Status Object | The actual status provided by the lead type status |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"default": true,
"status":
{
"life_cycle_state": "PENDING",
"id": "ECE7C00893674BE9AFC18C5F98A08D98",
"name": "Pending",
"description": "Pending Lead",
"alternative_code": "P"
},
"id": "D26B1A1D3CA3CC0BA3DBE334BCF0B10C"
}
GET leads/configuration/categories/list
This method returns the lead categories that are allowed to be used by leads of a specific type. Multiple lead categories are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
lead_type_identifier (mandatory) | Lead Type Identifier | The identifier of the type of the lead that will be using the categories. The categories are filtered against the allowed categories of the specified type. The allowed lead type 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead type category |
| default | Boolean | Determines if the lead type category is the default category in the lead type or not |
| category | Lead Category Object | The actual category provided by the lead type category |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"default": true,
"id": "B2AB3B7EC0674BA5B88D74EDC04180ED",
"category":
{
"name": "Software Purchase",
"description": "11112",
"code": "SP"
}
},
{
"default": false,
"id": "30BA35222BAC43CB95B15DC0C3AD3167",
"category":
{
"parent_id": "B4DC3C92510944BCB7EE4B71122AF139",
"name": "Cloud",
"description": null,
"code": "SP_CD"
}
},
{
"default": false,
"id": "1420F25CBA8B4B4B9191EC959160E75D",
"category":
{
"parent_id": "B4DC3C92510944BCB7EE4B71122AF139",
"name": "On Premises",
"description": null,
"code": "SP_OP"
}
}
GET leads/configuration/physical_goods/list
This method returns the physical goods that are allowed to be used by leads of specific type. Multiple physical goods are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
lead_type_identifier (mandatory) | Lead Type Identifier | The identifier of the type of the lead that will be using the physical goods. The physical goods are filtered against the allowed physical goods of the specified type. The allowed lead request type 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead type physical good |
Product Object | The actual product provided by the lead type physical good | |
| product_type | Product Type Object | The actual product type provided by the lead type physical good |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"product_type": null,
"id": "0C148ADC310741A99923BE8546B48F1E",
"product":
{
"id": "3F01BB0B40264DF7311660F63CB2180D",
"description": "Remote Control",
"code": "Remote Control",
"alternative_code": "REM"
}
},
{
"product_type": null,
"id": "F7E71C7E3D674358945BE113D96A66A2",
"product":
{
"id": "70FFDF2B2A74466DD7D0D5246ED1DD2D",
"description": "Antenna v1",
"code": "Antenna 1",
"alternative_code": "ANT1"
}
},
{
"product_type":
{
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "1FFC6C62DABA4C7BAA3536C24104E58A",
"name": "Software Product",
"description": null,
"alternative_code": "SP_1"
},
"id": "F5A880AA92D34326B4DC9E1D1677939A",
"product": null
}
GET leads/configuration/services/list
This method returns the services that are allowed to be used by leads of specific type. Multiple services are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
lead_type_identifier (mandatory) | Lead Type Identifier | The identifier of the type of the lead that will be using the services. The services are filtered against the allowed services of the specified type. The allowed lead type 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead type service |
Product Object | The actual product provided by the lead type service | |
| product_type | Product Type Object | The actual product type provided by the lead type service |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"product_type": null,
"id": "0C634981F1324EAF802AA88F8C3D2CCE",
"product":
{
"id": "E67206ADD5E939E31E0D34A2D35F2742",
"description": null,
"code": "Viasat Premium",
"alternative_code": "VP"
}
},
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "C195EEFC755F4939BF4B49FEDE7D60AB",
"name": "Software Services",
"description": null,
"alternative_code": "SS_1"
},
"id": "1E6FDDFC97CC4A7B9BE9261B692204A4",
"product": null
}
GET leads/configuration/activity_types/list
This method returns the activity types that are allowed to be used by leads of specific type. Multiple activity types are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
lead_type_identifier (mandatory) | Service Request Type Identifier | The identifier of the type of the lead that will be using the activity types. The activity types are filtered against the allowed activity types of the specified type. The allowed lead type 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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead type activity type |
| activity_type | Activity Type Object | The actual activity type provided by the lead type activity type |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"id": "304859F326AF40EC853D12E495C71CE3",
"name": "Demonstration",
"description": "demo",
"alternative_code": "D"
},
{
"id": "B40015D8287048628EC7BD32FC25B447",
"name": "Maintenance visits",
"description": "maintenance visits",
"alternative_code": "MV"
}
]
}
GET leads/configuration/priority_levels/list
This method returns the priority levels that are allowed to be used by leads of any type. Only priority levels defined in the active Lead Definitions and set as Supported are retrieved. Multiple priority levels are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead priority level |
name | String | The name of the retrieved lead priority level |
label | String | The label of the retrieved lead priority level |
Examples
HTTP Method: GET
Request:
Response:
{
"label": "Low Priority",
"id": "6D8A8517701B4AAB8B63A2BF08A5501F",
"name": 1
},
{
"label": "Medium Priority",
"id": "F47439E2D1DE4635A56837C9C99828D2",
"name": 2
},
{
"label": "High Priority",
"id": "64EC45054E444628B467CD863668B261",
"name": 3
}
GET leads/configuration/importance_levels/list
This method returns the importance levels that are allowed to be used by leads of any type. Only importance levels defined in the active Lead Definitions and set as Supported are retrieved. Multiple importance levels are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead importance level |
name | String | The name of the retrieved lead importance level |
label | String | The label of the retrieved lead importance level |
Examples
HTTP Method: GET
Request:
Response:
{
"label": "Very Low Importance",
"id": "A3392F780B4547B890B18F323AE068E3",
"name": "IMPORTANCE1"
},
{
"label": "Low Importance",
"id": "6945CE2D48BD419C89815FC02DFA26BF",
"name": "IMPORTANCE2"
},
{
"label": "Medium Importance",
"id": "F155686AEACA47928C021055E56F5BB1",
"name": "IMPORTANCE3"
}
GET leads/configuration/source_types/list
This method returns the source types that are allowed to be used by leads of any type. All Source Types defined in the active Lead Definitions are retrieved. Any custom Source Type which does not have a label is not retrieved. Multiple source types are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead source type |
name | String | The name of the retrieved lead source type |
label | String | The label of the retrieved lead source type |
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"label": "Advert Campaign",
"id": "F16E21C609DC4D5E9314E627D9335EF1",
"name": "ADVERTISEMENT"
},
{
"label": "Notifications Campaign",
"id": "ABEF7494701D49EFA1AA03DD0796414A",
"name": "NOTIFICATIONS"
},
{
"label": "via Media",
"id": "85D4D7B1CAE04AF58AE1692C3E5F593D",
"name": "CUSTOM1"
},
{
"label": "via SMS",
"id": "EA29FE96D7154278B86DF2D384B0F137",
"name": "CUSTOM3"
}
]
}
GET leads/configuration/lost_reasons/list
This method returns the lost reasons that are allowed to be used by leads of any type. All Lost Reasons defined in the active Lead Definitions are retrieved. Multiple lost reasons are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead lost reason |
name | String | The name of the retrieved lead lost reason |
alternative_code | String | The alternative code of the retrieved lead lost reason |
| description | String | The description of the retrieved lead lost reason |
Examples
HTTP Method: GET
Request:
Response:
{
"id": "2CCA640BAB9C49B2B057380380809BAA",
"name": "No Requirements Mapping",
"alternative_code": "NRM"
},
{
"id": "F0FE0C78A9FE4BB9BDD1B1DACF6D910C",
"name": "Not Interested",
"alternative_code": "NI"
},
{
"id": "0D41B1B5E3B4498E87E74051BD7D7711",
"name": "Competitor",
"alternative_code": "C_1"
}
GET leads/configuration/competitors/list
This method returns the competitors that are allowed to be used by leads of any type. All Competitors defined in the active Lead Definitions are retrieved. Multiple competitors are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead competitor |
name | String | The name of the retrieved lead competitor |
website | String | The website of the retrieved competitor |
| description | String | The description of the retrieved lead competitor |
Examples
HTTP Method: GET
Request:
Response:
{
"id": "F0EE8EDCD868415184CCAD6221E356B6",
"name": "Chargify",
"website": "www.chargify.com",
"description": "Chargify: CRM"
},
{
"id": "920ABF722D304B8890312E6C3241A062",
"name": "Rewards Tool",
"website": "www.competitor2.com",
"description": "Rewards Tool: Rewards"
}