Newer Version Available

This content describes an older version of this product. View Latest

Group Membership Requests—Private

Update the status of a request by a user to join a private group or get information about a request to join a private group. Get the value of requestId from the Group Membership Request response from a POST request to /chatter/groups/groupId/members/requests.

Resource
1/chatter/group-membership-requests/requestId
Available since version
27.0
HTTP methods
GET, HEAD, and PATCH
Request body for PATCH
Group Membership Request Update
Request parameters for PATCH
Parameter Name Type Description Available Since
responseMessage String Use this property to provide a message to the user if their membership request is declined. The value of this property is used only when the value of the status property is Declined.

The maximum length is 756 characters.

27.0
status String Valid values:
  • Accepted
  • Declined
27.0
Response body for PATCH
Group Membership Request
Response body for GET or HEAD
Group Membership Request
Example for PATCH
This example updates a request to join a private group from Pending to Accepted:
1/chatter/group-membership-requests/0I5D000000002fwKAA?status=Accepted

This is the JSON Group Membership Request response body:

1{
2   "createdDate": "2012-10-24T16:36:36.000Z",
3   "id": "0I5D000000002fwKAA",
4   "lastUpdateDate": "2012-10-24T16:43:57.000Z",
5   "requestedGroup": {
6      "id": "0F9D00000000j46KAA",
7      "url": "/services/data/v30.0/chatter/groups/0F9D00000000j46KAA"
8   },
9   "responseMessage": null,
10   "status": "Accepted",
11   "url": "/services/data/v30.0/chatter/group-membership-requests/0I5D000000002fwKAA",
12   "user": {
13      "companyName": "Universal Containers",
14      "firstName": "Deanna",
15      "id": "005D0000001LL8OIAW",
16      "isActive": true,
17      "lastName": "Li",
18      "motif": {
19         "color": "1797C0",
20         "largeIconUrl": "/img/icon/profile64.png",
21         "mediumIconUrl": "/img/icon/profile32.png",
22         "smallIconUrl": "/img/icon/profile16.png"
23      },
24      "mySubscription": null,
25      "name": "Deanna Li",
26      "photo": {
27         "fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
28         "largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
29         "photoVersionId": "729D00000000LJFIA2",
30         "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
31         "standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB"
32      },
33      "title": null,
34      "type": "User",
35      "url": "/services/data/v30.0/chatter/users/005D0000001LL8OIAW",
36      "userType": "Internal"
37   }
38}