Industries Common Resources Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Industries Common Resources
AI Accelerator and Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Collections and Recovery
Context Service
Criteria-Based Search and Filter
Data Processing Engine, Batch Management, and Monitor Workflow Services
Digital Lending
Discovery Framework
Decision Explainer
Einstein Relationship Insights
Einstein Standard Invocable Actions
Engagement
Group Membership and Households
Group Membership and Households Data Model
Group Membership and Households Standard Objects
Group Membership and Households Business APIs
REST Reference
Resources
Request Bodies
Address Input
Account Input
Account Relation Input
Group Definition Input
Group Input
Group Merge Input
Member Record Input
Relationships Input
Response Bodies
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Process Compliance Navigator
Record Alerts
Record Rollup Definitions
Scheduled Reminders
Sentiment Insights
Service Process Studio
Timeline
Virtual Calls
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

Account Relation Input

Input representation of an account relationship.
JSON example
{
      "relations":[
         {
            "type":"Direct",
            "roleRelationId":"0zlxx000000001dAAA",
            "relatedAccountId":"001xx000003GYodAAG",
            "startDate":"2023-06-15T00:00:00.000Z",
            "endDate":"2023-12-15T00:00:00.000Z",
            "relatedInverseRecordId":"",
            "isActive":true,
            "customFields":{
               "field1":"field1Value",
               "field2":"field1Value"
            }
         },
         {
            "type":"Indirect",
            "roleRelationId":"0zlxx000000001dGAC",
            "accountId":"001xx000003GYodACD",
            "startDate":"2023-02-15T00:00:00.000Z",
            "endDate":"2023-09-15T00:00:00.000Z",
            "isActive":true,
            "customFields":{
               "field1":"field1Value",
               "field2":"field1Value"
            }
         }
      ]
   }
Properties
Name Type Description Required or Optional Available Version
aarId String Record ID of the AccountRelationship object. Optional 58.0
accountId String Primary account involved in the relationship. If the account relationship type is direct, then Account ID is required. Optional 58.0
custom​Fields Map<String, Object> Custom fields associated with the AccountRelationship object. Optional 58.0
endDate String Date when the account relationship ends. Optional 58.0
hierarchy​Type String Hierarchy among the accounts that are related. For example, an account is related to another account as a parent, a peer, or a child. Optional 58.0
isActive Boolean Indicates whether the account is actively involved with the related account (true) or not (false). Optional 58.0
related​AccountId String Record ID of the related account. If the account relationship type is direct, then the related account ID is required. Optional 58.0
related​Inverse​RecordId String Record ID of the related inverse relationship record. Optional 58.0
role​Relation​Id String Record ID of the party role relationship. Required 58.0
startDate String Date when the account relationship starts. Optional 58.0
type String Type of account relationship, such as a direct or indirect relationship. The default value is false. If the related​Inverse​RecordId property is specified, then the relationship type is indirect. Optional 58.0