Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Group Definitions (POST)

Define a party relationship group of individuals or trusts to deliver support services or to manage shared processes, such as cases and benefits.

Resource

1/connect/group/group-definitions

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/group/group-definitions

Available version

58.0

Requires Chatter

HTTP methods

POST

Request body for POST

JSON example

1{
2    "accountDetail":{
3       "name":"prg5",
4       "ownerId":"005xx000001X7tNAAS",
5       "billingAddress":{
6          "street":"",
7          "city":"Los Angeles",
8          "state":"California",
9          "country":"USA",
10          "postalCode":"90042"
11       },
12       "shippingAddress":{
13          "street":"",
14          "city":"Los Angeles",
15          "state":"California",
16          "country":"USA",
17          "postalCode":"90042"
18       },
19       "phone":"0123456789"
20    },
21    "groupDetail":{
22       "name":"prg5",
23       "category":"Staying under the same roof",
24       "type":"Household",
25       "groupSize":"2",
26       "groupIncome":"20000",
27       "primaryAddress":{
28          "street":"",
29          "city":"Los Angeles",
30          "state":"California",
31          "country":"USA",
32          "postalCode":"90042"
33       }
34    },
35    "member":{
36       "records":[
37          {
38             "contactId":"003xx000004WhHQAA0",
39             "roles":"Decision Maker",
40             "relations":[
41                {
42                   "roleRelationId":"0zlxx0000000001AAA",
43                   "relatedContactId":"003xx000004WhJ2AAK",
44                   "startDate":"2023-06-14T00:00:00.000Z"
45                }
46             ]
47          }
48       ]
49    },
50    "externalMember":{
51       "records":[
52          {
53             "contactId":"003xx000004WhJ2AAK",
54             "roles":"Decision Maker"
55          }
56       ]
57    },
58    "relatedGroup":{
59       "relations":[
60          {
61             "type":"Direct",
62             "roleRelationId":"0zlxx000000001dAAA",
63             "relatedAccountId":"001xx000003GYodAAG"
64          }
65       ]
66    },
67    "relatedAccount":{
68       "relations":[
69          
70       ]
71    }
72 }

Properties

Name	Type	Description	Required or Optional	Available Version
`accountDetail`	Map<String, Object>	Account details associated with the party relationship group.	Required	58.0
`externalMember`	Member Record Input[]	External member details of the party relationship group.	Optional	58.0
`groupDetail`	Map<String, Object>	Party relationship group details, such as group size, group income, address, and associated custom fields.	Required	58.0
`member`	Member Record Input[]	Member details of the party relationship group being created.	Required	58.0
`relatedAccount`	Account Relation Input[]	Data of the account that’s related to the party relationship group being created.	Optional	58.0
`relatedGroup`	Account Relation Input[]	Data of the group that’s related to the party relationship group being created.	Optional	58.0

Response body for POST

Group Definition

Public Sector Developer Guide

Group Definitions (POST)