Tip
Available from CRM.COM R9.0.0

Table of Contents

maxLevel	2

...

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:

Include Page

	V4:group_identifier
	V4:group_identifier

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:

Include Page

	V4:unit_identifier
	V4:unit_identifier

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

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:

Include Page

	v4:lead_type_identifier
	v4:lead_type_identifier

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

...

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:

Include Page

	v4:lead_type_identifier
	v4:lead_type_identifier

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

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:

Include Page

	v4:lead_type_identifier
	v4:lead_type_identifier

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

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:

Include Page

	v4:lead_type_identifier
	v4:lead_type_identifier

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

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:

Include Page

	v4:lead_type_identifier
	v4:lead_type_identifier

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

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

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":
    {
        "labelmessage": "Low Priority",
        "iddescription": "6D8A8517701B4AAB8B63A2BF08A5501F",
        "namecode": "OK"
1    },
   { "data":
    [
  "label": "Medium Priority",    {
   "id": "F47439E2D1DE4635A56837C9C99828D2",        "namedefault": 2
false,
  },    {        "label": "HighLow Priority",
       "     "id": "64EC45054E444628B467CD863668B2616D8A8517701B4AAB8B63A2BF08A5501F",
            "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

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

  {1
        },
        {
            "default": false,
            "label": "Medium Priority",
            "id": "F47439E2D1DE4635A56837C9C99828D2",
            "name": 2
        },
        {
            "default": false,
            "label": "High Priority",
            "id": "64EC45054E444628B467CD863668B261",
            "name": 3
        },
        {
            "default": true,
            "label": null,
            "id": "C60160FEA1514FC0B4EC657140C712FC",
            "name": 4
        },
        {
            "default": false,
            "label": null,
            "id": "ACB307F841F64CC0838F4A0D960842C0",
            "name": 5
        },
        {
            "default": false,
            "label": null,
            "id": "70251AA5C4A64A9A89A263E1B295C210",
            "name": 6
        }
    ]
}

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

Include Page

	V4:lead_importance_levels_complete
	V4:lead_importance_levels_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "label": "Very Low Importance",
            "id": "A3392F780B4547B890B18F323AE068E3",
            "name": "IMPORTANCE1"
        },
        {
            "default": false,
            "label": "Low Importance",
            "id": "6945CE2D48BD419C89815FC02DFA26BF",
            "name": "IMPORTANCE2"
        },
        {
            "default": true,
            "label": "Very LowMedium Importance",
            "id": "A3392F780B4547B890B18F323AE068E3F155686AEACA47928C021055E56F5BB1",
            "name": "IMPORTANCE1IMPORTANCE3"
        },
   {     {
  "label": "Low Importance",        "iddefault": "6945CE2D48BD419C89815FC02DFA26BF"false,
            "namelabel": "IMPORTANCE2"Extremely High  Importance",
},    {        "labelid": "Medium Importance73486AC4CAB24C63BB42F117EA022BF0",
            "idname": "F155686AEACA47928C021055E56F5BB1CUSTOM1",
        }
"name": "IMPORTANCE3"   ]
}

GET leads/configuration/source_types/list

...

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

...

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

...

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

...

Versions Compared

Old Version 19

New Version 20

Key

GET leads/configuration/importance_levels/list

Resource URL

Parameters

Response Data

Examples

GET leads/configuration/importance_levels/list

Resource URL

Parameters

Response Data

Examples

GET leads/configuration/source_types/list

Page Comparison

Versions Compared

Old Version 19

New Version 20

Key

GET leads/configuration/importance_levels/list

Resource URL

Parameters

Response Data

Examples

GET leads/configuration/importance_levels/list

Resource URL

Parameters

Response Data

Examples

GET leads/configuration/source_types/list