Chilkat Online Tools

phpExt / Salesforce Platform APIs / Group Membership Requests—Private

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

// resp is a CkHttpResponse
$resp = $http->QuickRequest('PATCH','group!');
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "createdDate": "2023-11-22T11:46:32.000Z",
//   "id": "0I5...",
//   "lastUpdateDate": "2023-11-22T11:50:19.000Z",
//   "requestedGroup": {
//     "id": "0F9...",
//     "url": "/services/data/v58.0/chatter/groups/0F9..."
//   },
//   "responseMessage": null,
//   "status": "Accepted",
//   "url": "/services/data/v58.0/chatter/group-membership-requests/0I5...",
//   "user": {
//     "additionalLabel": null,
//     "communityNickname": "User1700653511864742682",
//     "companyName": null,
//     "displayName": "User Sample",
//     "firstName": "User",
//     "id": "005...",
//     "isActive": true,
//     "isInThisCommunity": true,
//     "lastName": "Sample",
//     "motif": {
//       "color": "1B96FF",
//       "largeIconUrl": "/img/icon/profile64.png",
//       "mediumIconUrl": "/img/icon/profile32.png",
//       "smallIconUrl": "/img/icon/profile16.png",
//       "svgIconUrl": null
//     },
//     "mySubscription": null,
//     "name": "User Sample",
//     "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

$createdDate = $jResp->stringOf('createdDate');
$id = $jResp->stringOf('id');
$lastUpdateDate = $jResp->stringOf('lastUpdateDate');
$Id = $jResp->stringOf('requestedGroup.id');
$v_Url = $jResp->stringOf('requestedGroup.url');
$responseMessage = $jResp->stringOf('responseMessage');
$status = $jResp->stringOf('status');
$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');
$userId = $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');
$PhotoUrl = $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 PATCH
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/group-membership-requests/:CHATTER_GROUP_REQUEST_ID?status=Accepted&responseMessage=Welcome to the group!

Postman Collection Item JSON

{
  "name": "Group Membership Requests—Private",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {}
  },
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/group-membership-requests/:CHATTER_GROUP_REQUEST_ID?status=Accepted&responseMessage=Welcome to the group!",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "chatter",
        "group-membership-requests",
        ":CHATTER_GROUP_REQUEST_ID"
      ],
      "query": [
        {
          "key": "status",
          "value": "Accepted"
        },
        {
          "key": "responseMessage",
          "value": "Welcome to the group!"
        }
      ],
      "variable": [
        {
          "key": "CHATTER_GROUP_REQUEST_ID",
          "value": ""
        }
      ]
    },
    "description": "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.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_group_membership_requests.htm?search_text=group-membership-requests"
  },
  "response": [
    {
      "name": "Successful Group Membership Requests—Private",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/group-membership-requests/:CHATTER_GROUP_REQUEST_ID?status=Accepted&responseMessage=Welcome to the group!",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "chatter",
            "group-membership-requests",
            ":CHATTER_GROUP_REQUEST_ID"
          ],
          "query": [
            {
              "key": "status",
              "value": "Accepted"
            },
            {
              "key": "responseMessage",
              "value": "Welcome to the group!"
            }
          ],
          "variable": [
            {
              "key": "CHATTER_GROUP_REQUEST_ID",
              "value": "0I5..."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 Nov 2023 11:50:19 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": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"createdDate\": \"2023-11-22T11:46:32.000Z\",\n    \"id\": \"0I5...\",\n    \"lastUpdateDate\": \"2023-11-22T11:50:19.000Z\",\n    \"requestedGroup\": {\n        \"id\": \"0F9...\",\n        \"url\": \"/services/data/v58.0/chatter/groups/0F9...\"\n    },\n    \"responseMessage\": null,\n    \"status\": \"Accepted\",\n    \"url\": \"/services/data/v58.0/chatter/group-membership-requests/0I5...\",\n    \"user\": {\n        \"additionalLabel\": null,\n        \"communityNickname\": \"User1700653511864742682\",\n        \"companyName\": null,\n        \"displayName\": \"User Sample\",\n        \"firstName\": \"User\",\n        \"id\": \"005...\",\n        \"isActive\": true,\n        \"isInThisCommunity\": true,\n        \"lastName\": \"Sample\",\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\": \"User Sample\",\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}"
    }
  ]
}