Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R18.0.0


Excerpt

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:

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, WON and CANCELLED

Tip

CANCELLED life cycle state available from CRM.COM R11.1.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

Response Data

Include Page
V4:lead_type_status_complete
V4:lead_type_status_complete

...

Expand
titleExample 1

HTTP Method: GET 


Request:

Response: 


code
Code Block
language
javascript
themeConfluencelanguagejavascript
linenumberstrue
 {
       "default": true,
       "status":
       {
           "life_cycle_state": "PENDING",
           "id": "ECE7C00893674BE9AFC18C5F98A08D98",
           "name": "Pending",
           "description": "Pending Lead",
           "alternative_code": "P"
       },
       "id": "D26B1A1D3CA3CC0BA3DBE334BCF0B10C"
   }


...