MktHierGrpNodeRuleDef

Represents a rule for a node in a marketing hierarchy group. Based on the rule type, the rule defines the allowed parent node or the user, group, or profile that can create marketing programs. 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
AppliesToId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user, group, or profile that the rule grants access to create marketing programs and their related records for the related marketing hierarchy group node. This field applies when `RuleType` is `CreatePrograms`. This field is a polymorphic relationship field. Relationship Name AppliesTo Refers To Group, Profile, User
AppliesToType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the create-programs rule applies to a user, group, or profile. This field applies when `RuleType` is `CreatePrograms`. Possible values are: `Group` `Profile` `User`
EligibleParentHierGrpNdId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the group node that is allowed as the parent. This field applies when `RuleType` is `AllowedParent`. This field is a relationship field. Relationship Name EligibleParentHierGrpNd Refers To MarketingHierarchyGroupNodeDef
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this rule is active. Inactive rules are ignored by validation. The default value is `false`.
RelatedHierGroupNodeId	Type reference Properties Create, Filter, Group, Sort Description The ID of the marketing hierarchy group node that this rule applies to. This field is a relationship field. Relationship Name RelatedHierGroupNode Relationship Type Master-detail Refers To MarketingHierarchyGroupNodeDef (the master object)
RuleType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the type of rule. Possible values are: `AllowedParent`—The rule declares which group node is allowed as the parent of the related node. `CreatePrograms`—The rule declares which user, group, or profile can create marketing programs and their related records for the related node.
ValidationErrorMessage	Type textarea Properties Create, Nillable, Update Description The custom error message shown to the user when this rule is violated.

Tooling API

MktHierGrpNodeRuleDef

Supported SOAP API Calls

Supported REST API Methods

Special Access Rules

Fields