Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "invitees": {
// "emails": [
// "testemail1@sfdcpostman.com",
// "testemail2@sfdcpostman.com"
// ]
// },
// "message": "Join this group to participate in the discussion about your favorite feature."
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("invitees.emails[0]","testemail1@sfdcpostman.com")
loJson.UpdateString("invitees.emails[1]","testemail2@sfdcpostman.com")
loJson.UpdateString("message","Join this group to participate in the discussion about your favorite feature.")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/chatter/groups/group/:GROUP_ID/invite","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "invitations": [
// {
// "email": "testemail1@sfdcpostman.com",
// "status": "Invited",
// "userId": ""
// },
// ...
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
lnCount_i = loJResp.SizeOfArray("invitations")
do while i < lnCount_i
loJResp.I = i
lnIntVal = loJResp.IntOf("invitations[i]")
i = i + 1
enddo
release loHttp
release loJson
release loSbResponseBody
release loJResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invitees" : {
"emails": [
"testemail1@sfdcpostman.com",
"testemail2@sfdcpostman.com"
]
},
"message" : "Join this group to participate in the discussion about your favorite feature."
}'
https://domain.com/services/data/v{{version}}/chatter/groups/group/:GROUP_ID/invite
Postman Collection Item JSON
{
"name": "Group Invites",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {
"content-type": true
}
},
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invitees\" : {\n \"emails\": [\n \"testemail1@sfdcpostman.com\",\n \"testemail2@sfdcpostman.com\"\n ]\n },\n \"message\" : \"Join this group to participate in the discussion about your favorite feature.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/group/:GROUP_ID/invite",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups",
"group",
":GROUP_ID",
"invite"
],
"variable": [
{
"key": "GROUP_ID",
"value": ""
}
]
},
"description": "Invite internal and external users to join a group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_invites.htm#connect_resources_groups_invites"
},
"response": [
{
"name": "Successful Group Invites",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invitees\" : {\n \"emails\": [\n \"testemail1@sfdcpostman.com\",\n \"testemail2@sfdcpostman.com\"\n ]\n },\n \"message\" : \"Join this group to participate in the discussion about your favorite feature.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/group/:GROUP_ID/invite",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups",
"group",
":GROUP_ID",
"invite"
],
"variable": [
{
"key": "GROUP_ID",
"value": "0F9..."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 11:49:28 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"invitations\": [\n {\n \"email\": \"testemail1@sfdcpostman.com\",\n \"status\": \"Invited\",\n \"userId\": \"\"\n },\n ...\n ]\n}"
}
]
}
