BusinessProcessDefinition

Represents information about stages in a customer lifecycle map.

Version 

Introduced in API version 51.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

BusinessProcessGroupId 

• Type: reference

• Properties: Create, Filter, Group, Sort

• Description: Unique identifier of the customer lifecycle map that is associated with the stage.

• Relationship name: BusinessProcessGroup

• Relationship type: relationship

• Refers to: BusinessProcessGroup

DeveloperName 

• Type: string

• Properties: Create, Filter, Group, Sort, Update

• Description: Developer name of the stage.

  Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  Note

Language 

• Type: picklist

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: Language of the MasterLabel.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

  • af — af — Afrikaans

  • am — am — Amharic

  • ar — ar — Arabic

  • ar_AE — ar_AE — Arabic (United Arab Emirates)

  • ar_BH — ar_BH — Arabic (Bahrain)

  • ar_DZ — ar_DZ — Arabic (Algeria)

  • ar_EG — ar_EG — Arabic (Egypt)

  • ar_IQ — ar_IQ — Arabic (Iraq)

  • ar_JO — ar_JO — Arabic (Jordan)

  • ar_KW — ar_KW — Arabic (Kuwait)

  • ar_LB — ar_LB — Arabic (Lebanon)

  • ar_LY — ar_LY — Arabic (Libya)

  • ar_MA — ar_MA — Arabic (Morocco)

  • ar_OM — ar_OM — Arabic (Oman)

  • ar_QA — ar_QA — Arabic (Qatar)

  • ar_SA — ar_SA — Arabic (Saudi Arabia)

  • ar_SD — ar_SD — Arabic (Sudan)

  • ar_SY — ar_SY — Arabic (Syria)

  • ar_TN — ar_TN — Arabic (Tunisia)

  • ar_YE — ar_YE — Arabic (Yemen)

  • bg — bg — Bulgarian

  • bn — bn — Bengali

  • bs — bs — Bosnian

  • ca — ca — Catalan

  • cs — cs — Czech

  • cy — cy — Welsh

  • de_AT — de_AT — German (Austria)

  • de_BE — de_BE — German (Belgium)

  • de_CH — de_CH — German (Switzerland)

  • de_LU — de_LU — German (Luxembourg)

  • el — el — Greek

  • en_AU — en_AU — English (Australian)

  • en_CA — en_CA — English (Canadian)

  • en_GB — en_GB — English (UK)

  • en_HK — en_HK — English (Hong Kong)

  • en_IE — en_IE — English (Ireland)

  • en_IN — en_IN — English (Indian)

  • en_MY — en_MY — English (Malaysian)

  • en_NZ — en_NZ — English (New Zealand)

  • en_PH — en_PH — English (Philippines)

  • en_SG — en_SG — English (Singapore)

  • en_ZA — en_ZA — English (South Africa)

  • es_AR — es_AR — Spanish (Argentina)

  • es_BO — es_BO — Spanish (Bolivia)

  • es_CL — es_CL — Spanish (Chile)

  • es_CO — es_CO — Spanish (Colombia)

  • es_CR — es_CR — Spanish (Costa Rica)

  • es_DO — es_DO — Spanish (Dominican Republic)

  • es_EC — es_EC — Spanish (Ecuador)

  • es_GT — es_GT — Spanish (Guatemala)

  • es_HN — es_HN — Spanish (Honduras)

  • es_NI — es_NI — Spanish (Nicaragua)

  • es_PA — es_PA — Spanish (Panama)

  • es_PE — es_PE — Spanish (Peru)

  • es_PR — es_PR — Spanish (Puerto Rico)

  • es_PY — es_PY — Spanish (Paraguay)

  • es_SV — es_SV — Spanish (El Salvador)

  • es_US — es_US — Spanish (United States)

  • es_UY — es_UY — Spanish (Uruguay)

  • es_VE — es_VE — Spanish (Venezuela)

  • et — et — Estonian

  • eu — eu — Basque

  • fa — fa — Farsi

  • fr_BE — fr_BE — French (Belgium)

  • fr_CA — fr_CA — French (Canadian)

  • fr_CH — fr_CH — French (Switzerland)

  • fr_LU — fr_LU — French (Luxembourg)

  • ga — ga — Irish

  • gu — gu — Gujarati

  • hi — hi — Hindi

  • hr — hr — Croatian

  • hu — hu — Hungarian

  • hy — hy — Armenian

  • in — in — Indonesian

  • is — is — Icelandic

  • it_CH — it_CH — Italian (Switzerland)

  • iw — iw — Hebrew

  • ka — ka — Georgian

  • km — km — Khmer

  • kn — kn — Kannada

  • lb — lb — Luxembourgish

  • lt — lt — Lithuanian

  • lv — lv — Latvian

  • mi — mi — Te reo

  • mk — mk — Macedonian

  • ml — ml — Malayalam

  • mr — mr — Marathi

  • ms — ms — Malay

  • mt — mt — Maltese

  • my — my — Burmese

  • nl_BE — nl_BE — Dutch (Belgium)

  • pl — pl — Polish

  • pt_PT — pt_PT — Portuguese (European)

  • rm — rm — Romansh

  • ro — ro — Romanian

  • ro_MD — ro_MD — Romanian (Moldova)

  • sh — sh — Serbian (Latin)

  • sh_ME — sh_ME — Montenegrin

  • sk — sk — Slovak

  • sl — sl — Slovene

  • sq — sq — Albanian

  • sr — sr — Serbian (Cyrillic)

  • sw — sw — Swahili

  • ta — ta — Tamil

  • te — te — Telugu

  • tl — tl — Tagalog

  • tr — tr — Turkish

  • uk — uk — Ukrainian

  • ur — ur — Urdu

  • vi — vi — Vietnamese

  • xh — xh — Xhosa

  • zh_HK — zh_HK — Chinese (Hong Kong)

  • zh_SG — zh_SG — Chinese (Singapore)

  • zu — zu — Zulu

MasterLabel 

• Type: string

• Properties: Create, Filter, Group, Sort, Update

• Description: Label of the stage.

ProcessDescription 

• Type: textarea

• Properties: Create, Nillable, Update

• Description: Description of the stage.

SequenceNumber 

• Type: int

• Properties: Create, Filter, Group, Sort, Update

• Introduced: API version 49.0

• Description: Position of the stage in the associated customer lifecycle map.