POST api/Groups
Create a new Group Record.
Request Information
URI Parameters
None.
Body Parameters
The Group record data must be passed in through the body of the request in Json format. Set Content-Type header to application/json
MutableEntityExtendedName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
ParentId |
This field will only include data when working with Group records. |
globally unique identifier |
None. |
Fields | Dictionary of string [key] and Object [value] |
None. |
|
LinkedEntities | LinkedEntities |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "9c4d87e6-c057-43cd-938b-54f63d9f17fe", "ParentId": "6ecb62fa-c6d1-4679-86aa-187cca6c3a48", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "1c1d91ee-4498-46e1-849e-e125c16764ad", "7d9ee360-9179-4dbd-990b-8396eac3d282" ], "Companies": [ "429e8ef2-e6bf-4e9f-b023-c1f9593f9789", "2d2fd2f6-1a07-4f1a-bb69-e75e05c5de2d" ], "Groups": [ "6f68b131-5eda-4604-880a-892beb6592b4", "bdf7c1c7-0669-40ca-8b50-339ed38e8e29" ], "Opportunities": [ "471a6215-5411-40a8-b18c-b5c094830efb", "ac136053-8f7f-4050-a89d-fa058406585a" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
This endpoint returns the GUID of the Group record once it is created.
globally unique identifierResponse Formats
application/json, text/json
Sample:
"46e7b952-6786-4cf1-9cd1-4a134a09bb28"