LeadStatus

Represents the status of a Lead, such as Open, Qualified, or Converted.

Supported Calls

describeSObjects(), query(), retrieve()

Fields

Field Details
ApiName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Uniquely identifies a picklist value so it can be retrieved without using an id or master label.
IsConverted
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this lead status value represents a converted lead (true) or not (false). Multiple lead status values can represent a converted lead.
IsDefault
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this is the default lead status value (true) or not (false) in the picklist.
MasterLabel
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Master label for this lead status value. This display value is the internal label that does not get translated.
SortOrder
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Number used to sort this value in the lead status picklist. These numbers are not guaranteed to be sequential, as some previous lead status values might have been deleted.

Usage

This object represents a value in the lead status picklist (see Lead Status Picklist). The lead status picklist provides additional information about the status of a Lead, such as whether a given status value represents a converted Lead. Query this object to retrieve the set of values in the lead status picklist, and then use that information while processing Lead objects to determine more information about a given lead. For example, the application could test whether a given lead is converted based on its Status value and the value of the IsConverted property in the associated LeadStatus record.

See Also