Versions Compared

Key

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

Available from CRM.COM R11.1.0

Excerpt

This method cancels a Lead but only as long as the Lead in not in life cycle state Won or Lost. A single lead can be cancelled by each call

...

Resource URL

Parameters

NameTypeDescription
token

String

The token retrieved from the login method

lead_identifier

(mandatory)

Lead Identifier

The identifier of the Lead to be cancelled. The allowed Lead identifier fields are the following:

Include Page
V4:lead_identifier
V4:lead_identifier

status_identifier

(optional)

Lead Status Identifier

The status that will be set on the Lead , after the cancellation. If not specified the the default status for cancelling Lead of that type will be used. The allowed Lead status identifiers are the following:

Include Page
V4:lead_status_identifier
V4:lead_status_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

...