Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user p_demou (Deactivated)

Saved on

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 competitors that are allowed to be used by leads of any typeor all types. All Competitors defined in the active Lead Definitions are retrieved if no type is defined. Multiple competitors are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

lead_type_identifier

(optional)

Lead Type Identifier

The identifier of the type of the lead that will be using the competitors. The competitors are filtered against the allowed competitors of the specified type. The allowed lead type identifier fields are the following:

Include Page
v4:lead_type_identifier
v4:lead_type_identifier

Tip

Available from CRM.COM R14.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

Response Data

Include Page
V4:lead_competitors_complete
V4:lead_competitors_complete

...

Expand
titleExample 1

HTTP Method: GET

 


Request:

Response:


Code Block
 code
language
javascript
themeConfluencelanguagejavascript
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"
   }



Expand
titleExample 2

HTTP Method: GET


Request:

Response:


Code Block
languagejavascript
themeConfluence
linenumberstrue
{
    "data": [
        {
            "website": null,
            "name": "MagnaQuest",
            "description": null,
            "id": "640A12797E964BFC99F8AF0EA538EEEA"
        },
        {
            "website": "Zuora.com",
            "name": "Zuora",
            "description": null,
            "id": "0CC8A3BDCA7B41B78058D0A178390B06"
        },
        {
            "website": "Chargify.com",
            "name": "Chargify",
            "description": null,
            "id": "02376768970343738D736979A1DE0C52"
        },
        {
            "website": null,
            "name": "Competitor 2",
            "description": null,
            "id": "9A63A715C5174BD4B70FBE49EAC79815"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}