Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

PathAssistant

Represents a Sales Path. Available in Tooling API version 36.0 and later.

Supported SOAP Calls

retrieve(), query()

Supported REST HTTP Methods

DELETE, GET, PATCH, POST

Fields

Field	Details
DeveloperName	Type string Properties Filter, Group, Sort Description The unique name of the sales path in the API.
FullName	Type string Properties Group, Nillable Description The name of the sales path in the Metadata API. Query this field only if the query result contains no more than 1 record. Otherwise, an error is returned. If more than 1 record exists, use multiple queries to retrieve the records. This limit protects performance.
IsActive	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the sales path is active (true) or inactive (false).
IsDeleted	Type boolean Properties Sort Description Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
IsMasterRecordType	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this sales path is for the master record type (true) or not (false).
Language	Type string Properties Filter, Group, Restricted picklist, Sort Description The language of the sales path. Valid values are: Chinese (Simplified): `zh_CN` Chinese (Traditional): `zh_TW` Danish: `da` Dutch: `nl_NL` English: `en_US` Finnish: `fi` French: `fr` German: `de` Italian: `it` Japanese: `ja` Korean: `ko` Norwegian: `no` Portuguese (Brazil): `pt_BR` Russian: `ru` Spanish: `es` Spanish (Mexico): `es_MX` Swedish: `sv` Thai: `th`
MasterLabel	Type string Properties Filter, Group, Sort Description Label for this sales path.
Metadata	Type msn:PathAssistant Properties Create, Nillable, Update Description Sales path metadata from the msn namespace. Query this field only if the query result contains no more than 1 record. Otherwise, an error is returned. If more than 1 record exists, use multiple queries to retrieve the records. This limit protects performance.
RecordTypeId	Type ID Properties Filter, Group, Nillable, Sort Description The unique identifier for a record type.
SobjectProcessField	Type string Properties Filter, Group, Restricted picklist, Sort Description Name of the picklist field which determines the steps you can use in the sales path. For example, OpportunityStage in the case of opportunities or LeadStatus in the case of leads.
SobjectType	Type string Properties Filter, Group, Restricted picklist, Sort Description The object this path relates to. Valid values are: `Opportunity` or `Lead`.