Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>")
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "id": "0FB...",
# "lastFeedAccessDate": null,
# "role": "StandardMember",
# "url": "/services/data/v58.0/chatter/group-memberships/0FB...",
# "user": {
# "additionalLabel": null,
# "communityNickname": "integration1.4407085834085586E12",
# "companyName": "Salesforce",
# "displayName": "Integration User",
# "firstName": "Integration",
# "id": "005...",
# "isActive": true,
# "isInThisCommunity": true,
# "lastName": "User",
# "motif": {
# "color": "1B96FF",
# "largeIconUrl": "/img/icon/profile64.png",
# "mediumIconUrl": "/img/icon/profile32.png",
# "smallIconUrl": "/img/icon/profile16.png",
# "svgIconUrl": null
# },
# "mySubscription": null,
# "name": "Integration User",
# "outOfOffice": {
# "message": ""
# },
# "photo": {
# "fullEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1",
# "largePhotoUrl": "https://<my_domain>/profilephoto/005/F",
# "mediumPhotoUrl": "https://<my_domain>/profilephoto/005/M",
# "photoVersionId": null,
# "smallPhotoUrl": "https://<my_domain>/profilephoto/005/T",
# "standardEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1",
# "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
# },
# "reputation": null,
# "title": null,
# "type": "User",
# "url": "/services/data/v58.0/chatter/users/005...",
# "userType": "Internal"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id = jResp.stringOf("id")
lastFeedAccessDate = jResp.stringOf("lastFeedAccessDate")
role = jResp.stringOf("role")
url = jResp.stringOf("url")
AdditionalLabel = jResp.stringOf("user.additionalLabel")
CommunityNickname = jResp.stringOf("user.communityNickname")
CompanyName = jResp.stringOf("user.companyName")
DisplayName = jResp.stringOf("user.displayName")
FirstName = jResp.stringOf("user.firstName")
Id = jResp.stringOf("user.id")
IsActive = jResp.BoolOf("user.isActive")
IsInThisCommunity = jResp.BoolOf("user.isInThisCommunity")
LastName = jResp.stringOf("user.lastName")
Color = jResp.stringOf("user.motif.color")
LargeIconUrl = jResp.stringOf("user.motif.largeIconUrl")
MediumIconUrl = jResp.stringOf("user.motif.mediumIconUrl")
SmallIconUrl = jResp.stringOf("user.motif.smallIconUrl")
SvgIconUrl = jResp.stringOf("user.motif.svgIconUrl")
MySubscription = jResp.stringOf("user.mySubscription")
Name = jResp.stringOf("user.name")
Message = jResp.stringOf("user.outOfOffice.message")
FullEmailPhotoUrl = jResp.stringOf("user.photo.fullEmailPhotoUrl")
LargePhotoUrl = jResp.stringOf("user.photo.largePhotoUrl")
MediumPhotoUrl = jResp.stringOf("user.photo.mediumPhotoUrl")
PhotoVersionId = jResp.stringOf("user.photo.photoVersionId")
SmallPhotoUrl = jResp.stringOf("user.photo.smallPhotoUrl")
StandardEmailPhotoUrl = jResp.stringOf("user.photo.standardEmailPhotoUrl")
v_Url = jResp.stringOf("user.photo.url")
Reputation = jResp.stringOf("user.reputation")
Title = jResp.stringOf("user.title")
v_Type = jResp.stringOf("user.type")
userUrl = jResp.stringOf("user.url")
UserType = jResp.stringOf("user.userType")
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>
Postman Collection Item JSON
{
"name": "Group Members",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups",
":GROUP_ID",
"members"
],
"query": [
{
"key": "userId",
"value": "<USER1_ID>"
}
],
"variable": [
{
"key": "GROUP_ID",
"value": ""
}
]
},
"description": "Members of a specified group. Get the members and add a member to a group. To add a member, the context user must be the group owner or moderator.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembers.htm"
},
"response": [
{
"name": "Successful Group Members",
"originalRequest": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=005...",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups",
":GROUP_ID",
"members"
],
"query": [
{
"key": "userId",
"value": "005..."
}
],
"variable": [
{
"key": "GROUP_ID",
"value": "0F9..."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 11:31:07 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 \"id\": \"0FB...\",\n \"lastFeedAccessDate\": null,\n \"role\": \"StandardMember\",\n \"url\": \"/services/data/v58.0/chatter/group-memberships/0FB...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"integration1.4407085834085586E12\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Integration User\",\n \"firstName\": \"Integration\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"User\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Integration User\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}"
}
]
}
