LeadStatus

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

Supported Calls

query(), retrieve(), describeSObjects()

Fields

Field Field Type Field Properties Description
IsConverted boolean Defaulted on create

Filter

Indicates whether this lead status value represents a converted lead (true) or not (false). Multiple lead status values can represent a converted lead. For more information, see convertLead().
IsDefault boolean Defaulted on create

Filter

Indicates whether this is the default lead status value (true) or not (false) in the picklist.
MasterLabel string Filter

Nillable

Master label for this lead status value. This display value is the internal label that does not get translated.
SortOrder int Filter

Nillable

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. Your client application can invoke the query() call on the LeadStatus 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 object.

This object is read-only via the API. With sufficient permissions, your client application can invoke the query() and describeSObjects() calls on this object.

© Copyright 2000-2009 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.