MarketingHierarchyGroupDef

Represents the top-level category of a marketing hierarchy that can be defined on various dimensions such as brand, industry, and region. This object is available in API version 68.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

Marketing Planning and Operations must be available to access this object. See Availability of Marketing Planning and Operations.

Fields

Field	Details
Description	Type textarea Properties Create, Nillable, Update Description The description of the hierarchy group.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. The name must be 40 characters or fewer, must begin with a letter, can contain only underscores and alphanumeric characters, can't include spaces, can't end with an underscore, and can't contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object's name in a managed package and the changes are reflected in a subscriber's organization.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the hierarchy group definition is active (true) or not (false). The default value is `false`.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code, which controls the language for the marketing hierarchy group definition. Possible values are: `af`—Afrikaans `am`—Amharic `ar`—Arabic `ar_AE`—Arabic (United Arab Emirates) `ar_BH`—Arabic (Bahrain) `ar_DZ`—Arabic (Algeria) `ar_EG`—Arabic (Egypt) `ar_IQ`—Arabic (Iraq) `ar_JO`—Arabic (Jordan) `ar_KW`—Arabic (Kuwait) `ar_LB`—Arabic (Lebanon) `ar_LY`—Arabic (Libya) `ar_MA`—Arabic (Morocco) `ar_OM`—Arabic (Oman) `ar_QA`—Arabic (Qatar) `ar_SA`—Arabic (Saudi Arabia) `ar_SD`—Arabic (Sudan) `ar_SY`—Arabic (Syria) `ar_TN`—Arabic (Tunisia) `ar_YE`—Arabic (Yemen) `bg`—Bulgarian `bn`—Bengali `bs`—Bosnian `ca`—Catalan `cac`—Chuj `cak`—Kaqchikel `cs`—Czech `cy`—Welsh `da`—Danish `de`—German `de_AT`—German (Austria) `de_BE`—German (Belgium) `de_CH`—German (Switzerland) `de_LI`—German (Liechtenstein) `de_LU`—German (Luxembourg) `el`—Greek `el_CY`—Greek (Cyprus) `en_AD`—English (Andorra) `en_AE`—English (United Arab Emirates) `en_AG`—English (Antigua and Barbuda) `en_AL`—English (Albania) `en_AT`—English (Austria) `en_AU`—English (Australian) `en_BA`—English (Bosnia and Herzegovina) `en_BB`—English (Barbados) `en_BE`—English (Belgium) `en_BG`—English (Bulgaria) `en_BS`—English (Bahamas) `en_BZ`—English (Belize) `en_CA`—English (Canadian) `en_CH`—English (Switzerland) `en_CY`—English (Cyprus) `en_CZ`—English (Czechia) `en_DE`—English (Germany) `en_DK`—English (Denmark) `en_DM`—English (Dominica) `en_EE`—English (Estonia) `en_ES`—English (Spain) `en_FI`—English (Finland) `en_FR`—English (France) `en_GB`—English (UK) `en_GD`—English (Grenada) `en_GI`—English (Gibraltar) `en_GR`—English (Greece) `en_GY`—English (Guyana) `en_HK`—English (Hong Kong) `en_HR`—English (Croatia) `en_HU`—English (Hungary) `en_IE`—English (Ireland) `en_IL`—English (Israel) `en_IN`—English (Indian) `en_IS`—English (Iceland) `en_IT`—English (Italy) `en_JM`—English (Jamaica) `en_JP`—English (Japan) `en_KN`—English (St. Kitts and Nevis) `en_KR`—English (South Korea) `en_LC`—English (St. Lucia) `en_LI`—English (Liechtenstein) `en_LT`—English (Lithuania) `en_LU`—English (Luxembourg) `en_LV`—English (Latvia) `en_MC`—English (Monaco) `en_ME`—English (Montenegro) `en_MK`—English (North Macedonia) `en_MT`—English (Malta) `en_MU`—English (Mauritius) `en_MY`—English (Malaysian) `en_NL`—English (Netherlands) `en_NO`—English (Norway) `en_NZ`—English (New Zealand) `en_PH`—English (Phillipines) `en_PL`—English (Poland) `en_PT`—English (Portugal) `en_RO`—English (Romania) `en_RS`—English (Serbia) `en_SE`—English (Sweden) `en_SG`—English (Singapore) `en_SI`—English (Slovenia) `en_SK`—English (Slovakia) `en_TH`—English (Thailand) `en_TR`—English (Turkey) `en_TT`—English (Trinidad and Tobago) `en_TW`—English (Taiwan) `en_US`—English `en_VC`—English (St. Vincent and the Grenadines) `en_ZA`—English (South Africa) `eo`—Esperanto (Pseudo) `eo_US`—Esperanto UniqueId (Pseudo) `es`—Spanish `es_AD`—Spanish (Andorra) `es_AR`—Spanish (Argentina) `es_BO`—Spanish (Bolivia) `es_CL`—Spanish (Chile) `es_CO`—Spanish (Colombia) `es_CR`—Spanish (Costa Rica) `es_DO`—Spanish (Dominican Republic) `es_EC`—Spanish (Ecuador) `es_GT`—Spanish (Guatemala) `es_HN`—Spanish (Honduras) `es_MX`—Spanish (Mexico) `es_NI`—Spanish (Nicaragua) `es_PA`—Spanish (Panama) `es_PE`—Spanish (Peru) `es_PR`—Spanish (Puerto Rico) `es_PY`—Spanish (Paraguay) `es_SV`—Spanish (El Salvador) `es_US`—Spanish (United States) `es_UY`—Spanish (Uruguay) `es_VE`—Spanish (Venezuela) `et`—Estonian `eu`—Basque `fa`—Farsi `fi`—Finnish `fr`—French `fr_BE`—French (Belgium) `fr_CA`—French (Canadian) `fr_CH`—French (Switzerland) `fr_HT`—French (Haiti) `fr_LU`—French (Luxembourg) `fr_MA`—French (Morocco) `ga`—Irish `gu`—Gujarati `haw`—Hawaiian `hi`—Hindi `hmn`—Hmong `hr`—Croatian `ht`—Haitian Creole `hu`—Hungarian `hy`—Armenian `in`—Indonesian `is`—Icelandic `it`—Italian `it_CH`—Italian (Switzerland) `iw`—Hebrew `iw_EO`—Esperanto RTL (Pseudo) `ja`—Japanese `ji`—Yiddish `ka`—Georgian `kk`—Kazakh `kl`—Greenlandic `km`—Khmer `kn`—Kannada `ko`—Korean `lb`—Luxembourgish `lt`—Lithuanian `lv`—Latvian `mi`—Te reo `mk`—Macedonian `ml`—Malayalam `mr`—Marathi `ms`—Malay `mt`—Maltese `my`—Burmese `nl_BE`—Dutch (Belgium) `nl_NL`—Dutch `nl_SR`—Dutch (Suriname) `no`—Norwegian `pa`—Punjabi `pl`—Polish `pt_AO`—Portuguese (Angola) `pt_BR`—Portuguese (Brazil) `pt_PT`—Portuguese (European) `quc`—Kiche `rm`—Romansh `ro`—Romanian `ro_MD`—Romanian (Moldova) `ru`—Russian `ru_AM`—Russian (Armenia) `ru_BY`—Russian (Belarus) `ru_KG`—Russian (Kyrgyzstan) `ru_KZ`—Russian (Kazakhstan) `ru_LT`—Russian (Lithuania) `ru_MD`—Russian (Moldova) `ru_PL`—Russian (Poland) `ru_UA`—Russian (Ukraine) `sh`—Serbian (Latin) `sh_ME`—Montenegrin `sk`—Slovak `sl`—Slovene `sm`—Samoan `sq`—Albanian `sr`—Serbian (Cyrillic) `sv`—Swedish `sv_FI`—Swedish (Finland) `sw`—Swahili `ta`—Tamil `te`—Telugu `th`—Thai `tl`—Tagalog `tr`—Turkish `uk`—Ukrainian `ur`—Urdu `vi`—Vietnamese `xh`—Xhosa `zh_CN`—Chinese (Simplified) `zh_HK`—Chinese (Hong Kong) `zh_MY`—Chinese (Malaysia) `zh_SG`—Chinese (Singapore) `zh_TW`—Chinese (Traditional) `zu`—Zulu
ManageableState	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package. Possible values are: `beta`—Managed-Beta `deleted`—Managed-Proposed-Deleted `deprecated`—Managed-Proposed-Deprecated `deprecatedEditable`—SecondGen-Installed-Deprecated `installed`—Managed-Installed `installedEditable`—SecondGen-Installed-Editable `released`—Managed-Released `unmanaged`—Unmanaged
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The label for this marketing hierarchy group definition value. This display value is the internal label that doesn't get translated.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field's value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
UsageType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the use case for this hierarchy group definition. Possible values are: `MktOps`

Tooling API

MarketingHierarchyGroupDef

Supported SOAP API Calls

Supported REST API Methods

Special Access Rules

Fields