Relationships Input

Input representation of the relationship among members of a party relationship group.

JSON example

1"relations":[
2               {
3                  "roleRelationId":"0zlRM0000004CAaYAM",
4                  "relatedContactId":"003RM00000895NFYAY",
5                  "startDate":"2023-06-14T00:00:00.000Z",
6                  "endDate":"2024-06-14T00:00:00.000Z",
7                  "isActive":true,
8                  "customFields":{
9                     "field1":"field1Value",
10                     "field2":"field1Value"
11                  }
12               }
13            ]

Properties

Name	Type	Description	Required or Optional	Available Version
`ccrId`	String	Record ID of the ContactContactRelationship object.	Optional	58.0
`customFields`	Map<String, Object>	Custom fields associated with the ContactRelationship object.	Optional	58.0
`endDate`	String	Date when the contact relationship ends.	Optional	58.0
`hierarchyType`	String	Hierarchy among the contacts that are related.	Optional	58.0
`isActive`	Boolean	Indicates whether the relationship is active (`true`) or not (`false`).	Optional	58.0
`relatedContactId`	String	Record ID of the RelatedContact object.	Required	58.0
`relatedInverseRecordId`	String	Record ID of the related inverse record.	Optional	58.0
`roleRelationId`	String	Record ID of the PartyRoleRelation object.	Required	58.0
`startDate`	String	Date when the contact relationship starts.	Optional	58.0

Public Sector Solutions Developer Guide

Relationships Input