Flexible Hierarchy Rule-Based Creation Input

Input representation to create or update flexible hierarchies in bulk asynchronously by applying relationship graph definition rules.

JSON Example 

 
1{
2  "operationMode": "create",
3  "relationshipGraphDefinitionIds": [
4    "06JRG000000001AMA2"
5  ],
6  "rootRecords": [
7    {
8      "recordId": "001xx000003GZ39AAG",
9      "name": "PID8 5-Level Hierarchy"
10    }
11  ],
12  "shouldIncludeAllRootRecords": false,
13  "effectiveFromDate": "2026-07-09",
14  "effectiveToDate": "2027-07-09",
15  "isActive": true
16}

Properties 
NameTypeDescriptionRequired or OptionalAvailable Version
effectiveFromDateStringDate when the generated hierarchies become effective. Don’t specify this parameter when operationMode is update.Optional68.0
effectiveToDateStringDate until which the generated hierarchies remain effective. Don’t specify this parameter when operationMode is update.Optional68.0
hierarchyIdsString[]IDs of the existing hierarchies to apply the rule. Required to update the hierarchies. Specify up to 1,000 records to process for the update operation. Don’t specify this parameter when operationMode is create.Required if operationMode is update.68.0
isActiveBooleanIndicates whether the generated hierarchies are active (true) or not (false). The default value is true. Don’t specify this parameter when operationMode is update.Optional68.0
operationModeStringSpecifies whether to create new flexible hierarchies or update existing ones. create creates new flexible hierarchies, and update synchronizes existing hierarchies with the latest source data.Required68.0
relationshipGraphDefinitionIdsString[]ID of the relationship graph definition that defines how the hierarchies are generated. Specify one ID at a time. Don’t specify this parameter when operationMode is update.Required if operationMode is create.68.0
rootRecordsRoot Record Input[]Root records to create flexible hierarchies for. Specify up to 1,000 root records. Use this parameter when operationMode is create and shouldIncludeAllRootRecords is false or not specified. Don’t specify this parameter when operationMode is update.Required if operationMode is create and shouldIncludeAllRootRecords is false or omitted.68.0
shouldIncludeAllRootRecordsBooleanIndicates whether to generate hierarchies for all root records that match the relationship graph definition (true) or not (false). Don’t specify this parameter when operationMode is update.Optional68.0

Get Started
Standard Objects
Managed Package Objects
Associated Objects
Metadata API Types
Custom Metadata Types
Tooling APIs
Apex Reference
Business APIs
REST Reference
Resources
Request Bodies
Actionable List Definition Source Column Input
Actionable List Definition Update Input
Actionable List Definitions Create Input
Actionable List Definitions Member Status Input
Actionable List Definitions Records Input
Actionable List Definitions Source Details Input
Filter Input
Actionable Lists Upsert Input
Address Input
Asset Input
Borrower Address Input
Borrower Declaration Input
Borrower Employment Input
Borrower Income Input
Borrower Input
Case Info Wrapper
Case Participant Info Wrapper
Complaint Info Wrapper
Complaint Management Request Input
Document Info Attributes Wrapper
Ethoca Alert Callback Input
Ethoca Event
Ethoca Links
Extended Fields Input
Filter Criteria
Financial Goal Create Input
Financial Goal Funding Input
Financial Goal Input
Financial Goal List Create Input
Financial Goal Party Input
Financial Goal Patch Input
Financial Goal Query Input
Financial Input
Flexible Hierarchy Bulk Validation Input
Flexible Hierarchy Bulk Validation Filter Input
Flexible Hierarchy Check Sync Input
Flexible Hierarchy Filters Input
Flexible Hierarchy Rule-Based Creation Input
Root Record Input
Generic Object Wrapper
Liability Input
Mapper Input Representation
Mortgage Input
Property Input
Title Holder Input
Referral Assignment Assignee Input
Referral Assignment Condition Input
Referral Assignment Rule Input
Referral Assignment Rule Order Input
Referral Assignment Rule Order Item Input
Referral Assignment Rule Status Update Input
Referral Assignment Rule Update Input
Referral Form Configuration Input
Referral Form Configuration Management Input
Step Section Condition Management Input
Referral Form Configuration Step Section Field Management Input
Referral Form Configuration Success Message Management Input
Referral Form Configuration Success Rule Message Management Input
Referral Form Configuration Welcome Consent Management Input
Referral Form Configuration Welcome Content Management Input
Step Section Visibility Condition Input
Referral Form Configuration Step Section Input
Referral Form Configuration Success Message Rule Management Input
Intake Success Screen Management Input
Intake Welcome Management Input
Referral Form Configuration Step Input
Referral Form Definition Status Update Input
Referral Input
Response Bodies
Standard Invocable Actions
Custom Triggers
Custom Validation Rules
DPE and Monitor Workflow Services
API End-of-Life Policy
Previous Versions