Versions Compared

Old Version 20

changes.mady.by.user Marios Michael

Saved on

compared with

New Version Current

changes.mady.by.user p_demou

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R9.0.0

Table of Contents
maxLevel2

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)

...

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)

...

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
       "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)

...

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)

...

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
       "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)

...

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
       "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)

...

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
       "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)

...

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
       "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)

...

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "label": "Low Priority",
            "id": "6D8A8517701B4AAB8B63A2BF08A5501F",
            "name": 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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "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": "Medium Importance",
            "id": "F155686AEACA47928C021055E56F5BB1",
            "name": "IMPORTANCE3"
        },
        {
            "default": false,
            "label": "Extremely High Importance",
            "id": "73486AC4CAB24C63BB42F117EA022BF0",
            "name": "CUSTOM1"
        }
    ]
}

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
       "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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
       "id": "F0EE8EDCD868415184CCAD6221E356B6",
       "name": "Chargify",
       "website": "www.chargify.com",
       "description": "Chargify: CRM"
   },
   {
       "id": "920ABF722D304B8890312E6C3241A062",
       "name": "Rewards Tool",
       "website": "www.competitor2.com",
       "description": "Rewards Tool: Rewards"
   }

 

...

Panel
nameblue

Child pages (Children Display)
excerpttrue