Group Definitions Merge (POST) | Public Sector Solutions Developer Guide

1/connect/group/group-definitions/actions/merge

1https://yourInstance.salesforce.com/services/data/v65.0/connect/group/group-definitions/actions/merge

58.0

No

POST

JSON example

1{
2   "primaryAccountId":"001RM000005aGUcYAM",
3   "secondaryAccountId":"001RM000005YYfiYAG",
4   "accountDetail":{
5      "customFields":{
6         "Account_CF1__c":"123",
7         "Account_CF2__c":"342"
8      },
9      "name":"Jones-Marshal HH",
10      "fax":"213762",
11      "billingAddress":{
12         "street":"",
13         "city":"",
14         "state":"",
15         "country":"",
16         "postalCode":""
17      },
18      "shippingAddress":{
19         "street":"",
20         "city":"",
21         "state":"",
22         "country":"",
23         "postalCode":""
24      },
25      "annualRevenue":"1500",
26      "numberOfEmployees":"35",
27      "type":"Agriculture"
28   },
29   "groupDetail":{
30      "customFields":{
31         "CF2__c":"123"
32      },
33      "name":"Jones-Marshal HH",
34      "category":"Staying under the same roof",
35      "status":"Active",
36      "description":"Merged household from Jones and Marshal HH",
37      "type":"Household",
38      "groupSize":"52",
39      "groupIncome":"4132",
40      "primaryAddress":{
41         "street":"",
42         "city":"",
43         "state":"",
44         "country":"",
45         "postalCode":""
46      },
47      "partyRelationGroupId":"0wKRM000000001n2AA"
48   },
49   "member":{
50      "records":[
51         {
52            "acrId":"07kRM000000Op0fYAC",
53            "contactId":"003RM00000895N9YAI",
54            "isPrimaryMember":false,
55            "isActive":true,
56            "isPrimaryGroup":false,
57            "roles":"Economic Decision Maker;Decision Maker",
58            "direct":false,
59            "customFields":{
60               "CF1__c":"2023-02-20",
61               "CF2__c":"CF2: Geoff"
62            },
63            "relations":[
64               
65            ]
66         },
67         {
68            "acrId":"07kRM000000KXvrYAG",
69            "contactId":"003RM00000895NDYAY",
70            "isPrimaryMember":true,
71            "isActive":true,
72            "isPrimaryGroup":false,
73            "roles":"Decision Maker",
74            "direct":false,
75            "customFields":{
76               "CF1__c":"2023-02-19",
77               "CF2__c":"CF2: Howard"
78            },
79            "relations":[
80               
81            ]
82         },
83         {
84            "acrId":"07kRM000000KYHkYAO",
85            "contactId":"003RM000008D6q0YAC",
86            "isPrimaryMember":false,
87            "isActive":true,
88            "isPrimaryGroup":false,
89            "roles":"Other;Influencer",
90            "direct":false,
91            "customFields":{
92               "CF1__c":"2023-03-08"
93            },
94            "relations":[
95               {
96                  "ccrId":"0zmRM000000002EYAQ",
97                  "roleRelationId":"0zlRM0000000014YAA",
98                  "relatedContactId":"003RM00000895N9YAI",
99                  "isActive":false
100               },
101               {
102                  "ccrId":"0zmRM000000002NYAQ",
103                  "roleRelationId":"0zlRM0000004CAaYAM",
104                  "relatedContactId":"003RM00000895NFYAY",
105                  "isActive":true
106               }
107            ]
108         }
109      ]
110   },
111   "externalMember":{
112      "records":[
113         {
114            "acrId":"07kRM000000KYHpYAO",
115            "contactId":"003RM00000895NFYAY",
116            "isPrimaryMember":false,
117            "isActive":true,
118            "isPrimaryGroup":false,
119            "roles":"Technical Buyer",
120            "direct":false,
121            "relations":[
122               
123            ]
124         },
125         {
126            "acrId":"07kRM000000OpPdYAK",
127            "contactId":"003RM0000089pihYAA",
128            "isPrimaryMember":false,
129            "isActive":true,
130            "isPrimaryGroup":false,
131            "roles":"Influencer",
132            "direct":false,
133            "relations":[
134               
135            ]
136         }
137      ]
138   },
139   "relatedGroup":{
140      "relations":[
141         {
142            "aarId":"0zoRM0000004CBKYA2",
143            "roleRelationId":"0zlRM000000001JYAQ",
144            "accountId":"001RM000005aVTBYA2",
145            "relatedAccountId":"001RM000005aGUcYAM",
146            "isActive":true,
147            "hierarchyType":"Peer",
148            "customFields":{
149               "CF3__c":false
150            }
151         },
152         {
153            "aarId":"0zoRM000000003KYAQ",
154            "roleRelationId":"0zlRM0000004C9mYAE",
155            "accountId":"001RM000005YNUAYA4",
156            "relatedAccountId":"001RM000005aGUcYAM",
157            "startDate":"2023-03-05T00:00:00.000Z",
158            "endDate":"2023-03-31T00:00:00.000Z",
159            "isActive":true,
160            "hierarchyType":"Parent",
161            "customFields":{
162               "CF3__c":false
163            }
164         },
165         {
166            "aarId":"0zoRM000000003PYAQ",
167            "roleRelationId":"0zlRM0000004C9mYAE",
168            "accountId":"001RM000005YNUTYA4",
169            "relatedAccountId":"001RM000005aGUcYAM",
170            "startDate":"2023-03-05T00:00:00.000Z",
171            "endDate":"2023-03-31T00:00:00.000Z",
172            "isActive":true,
173            "hierarchyType":"Parent",
174            "customFields":{
175               "CF3__c":false
176            }
177         },
178         {
179            "aarId":"0zoRM0000004CBAYA2",
180            "roleRelationId":"0zlRM000000001JYAQ",
181            "accountId":"001RM000005iEBkYAM",
182            "relatedAccountId":"001RM000005aGUcYAM",
183            "isActive":true,
184            "hierarchyType":"Peer",
185            "customFields":{
186               "CF3__c":false
187            }
188         },
189         {
190            "aarId":"0zoRM000000003GYAQ",
191            "roleRelationId":"0zlRM0000004C9mYAE",
192            "accountId":"001RM000005YNUOYA4",
193            "relatedAccountId":"001RM000005aGUcYAM",
194            "startDate":"2023-03-05T00:00:00.000Z",
195            "endDate":"2023-03-31T00:00:00.000Z",
196            "isActive":true,
197            "hierarchyType":"Parent",
198            "customFields":{
199               "CF3__c":false
200            }
201         },
202         {
203            "aarId":"0zoRM0000004CDPYA2",
204            "roleRelationId":"0zlRM0000004C9mYAE",
205            "accountId":"001RM000005aVWKYA2",
206            "relatedAccountId":"001RM000005aGUcYAM",
207            "startDate":"2023-03-05T00:00:00.000Z",
208            "endDate":"2023-03-31T00:00:00.000Z",
209            "isActive":true,
210            "hierarchyType":"Parent",
211            "customFields":{
212               "CF3__c":false
213            }
214         },
215         {
216            "aarId":"0zoRM0000004CBFYA2",
217            "roleRelationId":"0zlRM000000001JYAQ",
218            "accountId":"001RM000005aVSIYA2",
219            "relatedAccountId":"001RM000005aGUcYAM",
220            "startDate":"2023-03-07T00:00:00.000Z",
221            "endDate":"2023-04-08T00:00:00.000Z",
222            "isActive":true,
223            "hierarchyType":"Peer",
224            "customFields":{
225               "CF3__c":false
226            }
227         }
228      ]
229   },
230   "relatedAccount":{
231      "relations":[
232         {
233            "aarId":"0zoRM0000004CAuYAM",
234            "roleRelationId":"0zlRM0000004C9mYAE",
235            "accountId":"001RM000005aGUcYAM",
236            "relatedAccountId":"001RM000005ZLa5YAG",
237            "isActive":true,
238            "hierarchyType":"Peer",
239            "customFields":{
240               "CF3__c":false,
241               "CF4__c":"A;C"
242            }
243         },
244         {
245            "aarId":"0zoRM0000004CB4YAM",
246            "roleRelationId":"0zlRM000000001JYAQ",
247            "accountId":"001RM000005aGUcYAM",
248            "relatedAccountId":"001RM000005aGUNYA2",
249            "isActive":false,
250            "hierarchyType":"Peer",
251            "customFields":{
252               "CF3__c":false,
253               "CF4__c":"A;D"
254            }
255         },
256         {
257            "aarId":"0zoRM000000004mYAA",
258            "roleRelationId":"0zlRM000000001TYAQ",
259            "accountId":"001RM000005aGUcYAM",
260            "relatedAccountId":"001RM000005YXsUYAW",
261            "isActive":true,
262            "hierarchyType":"Peer",
263            "customFields":{
264               "CF3__c":true,
265               "CF4__c":"A;C"
266            }
267         }
268      ]
269   },
270   "tasks":[
271      "a03RM0000001Npi",
272      "a03RM0000001Npn"
273   ]
274}

Properties

Name	Type	Description	Required or Optional	Available Version
`accountDetail`	Account Input	Details of the merged account.	Required	58.0
`externalMember`	Member Record Input	Details of the external members of a party relationship group.	Optional	58.0
`groupDetail`	Group Input	Details of the party relationship group, such as category, address, group size, group income, and custom fields.	Required	58.0
`member`	Member Record Input	Details of the party relationship group members.	Required	58.0
`primaryAccountId`	String	ID of the primary account.	Required	58.0
`relatedAccount`	Account Relation Input	Details of the related account.	Optional	58.0
`relatedGroup`	Account Relation Input	Details of the party relationship group.	Optional	58.0
`secondaryAccountId`	String	ID of the secondary account.	Required	58.0
`tasks`	String[]	List of the records to create tasks for. For example, a task to assign benefits from the source party relationship group to the destination party relationship group.	Optional	58.0

Group Definition