---
schema_version: "1"
id: c992cf8acf617cc2f7d1af0b0c1d4589c56342543756dbdb99c4d1df34ab83a5
title: MarketingHierarchyGroupDef
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_marketinghierarchygroupdef.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_marketinghierarchygroupdef.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 5c56e53d5eb4a06f44879d761fb5c30c42d6103db6f4b3445e5e9ef66ef35dc8
description: 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.
---
# 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.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note_important.png)

#### Important

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.

## 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](https://help.salesforce.com/s/articleView?id=mktg.mktg_pln_oper_setup_editions.htm&language=en_US).

## 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





 |