Chilkat Online Tools

PowerBuilder / Salesforce Platform APIs / Group Members—Private - POST

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_CreatedDate
string ls_Id
string ls_LastUpdateDate
string ls_Id
string ls_V_Url
string ls_ResponseMessage
string ls_Status
string ls_Url
string ls_AdditionalLabel
string ls_CommunityNickname
string ls_CompanyName
string ls_DisplayName
string ls_FirstName
string ls_UserId
integer li_IsActive
integer li_IsInThisCommunity
string ls_LastName
string ls_Color
string ls_LargeIconUrl
string ls_MediumIconUrl
string ls_SmallIconUrl
string ls_SvgIconUrl
string ls_MySubscription
string ls_Name
string ls_Message
string ls_FullEmailPhotoUrl
string ls_LargePhotoUrl
string ls_MediumPhotoUrl
string ls_PhotoVersionId
string ls_SmallPhotoUrl
string ls_StandardEmailPhotoUrl
string ls_PhotoUrl
string ls_Reputation
string ls_Title
string ls_V_Type
string ls_UserUrl
string ls_UserType

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"

loo_Resp = loo_Http.QuickRequest("POST","https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests")
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

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

// {
//   "createdDate": "2023-11-22T11:52:41.000Z",
//   "id": "0I5...",
//   "lastUpdateDate": "2023-11-22T11:52:41.000Z",
//   "requestedGroup": {
//     "id": "0F9...",
//     "url": "/services/data/v58.0/chatter/groups/0F9..."
//   },
//   "responseMessage": null,
//   "status": "Pending",
//   "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

ls_CreatedDate = loo_JResp.StringOf("createdDate")
ls_Id = loo_JResp.StringOf("id")
ls_LastUpdateDate = loo_JResp.StringOf("lastUpdateDate")
ls_Id = loo_JResp.StringOf("requestedGroup.id")
ls_V_Url = loo_JResp.StringOf("requestedGroup.url")
ls_ResponseMessage = loo_JResp.StringOf("responseMessage")
ls_Status = loo_JResp.StringOf("status")
ls_Url = loo_JResp.StringOf("url")
ls_AdditionalLabel = loo_JResp.StringOf("user.additionalLabel")
ls_CommunityNickname = loo_JResp.StringOf("user.communityNickname")
ls_CompanyName = loo_JResp.StringOf("user.companyName")
ls_DisplayName = loo_JResp.StringOf("user.displayName")
ls_FirstName = loo_JResp.StringOf("user.firstName")
ls_UserId = loo_JResp.StringOf("user.id")
li_IsActive = loo_JResp.BoolOf("user.isActive")
li_IsInThisCommunity = loo_JResp.BoolOf("user.isInThisCommunity")
ls_LastName = loo_JResp.StringOf("user.lastName")
ls_Color = loo_JResp.StringOf("user.motif.color")
ls_LargeIconUrl = loo_JResp.StringOf("user.motif.largeIconUrl")
ls_MediumIconUrl = loo_JResp.StringOf("user.motif.mediumIconUrl")
ls_SmallIconUrl = loo_JResp.StringOf("user.motif.smallIconUrl")
ls_SvgIconUrl = loo_JResp.StringOf("user.motif.svgIconUrl")
ls_MySubscription = loo_JResp.StringOf("user.mySubscription")
ls_Name = loo_JResp.StringOf("user.name")
ls_Message = loo_JResp.StringOf("user.outOfOffice.message")
ls_FullEmailPhotoUrl = loo_JResp.StringOf("user.photo.fullEmailPhotoUrl")
ls_LargePhotoUrl = loo_JResp.StringOf("user.photo.largePhotoUrl")
ls_MediumPhotoUrl = loo_JResp.StringOf("user.photo.mediumPhotoUrl")
ls_PhotoVersionId = loo_JResp.StringOf("user.photo.photoVersionId")
ls_SmallPhotoUrl = loo_JResp.StringOf("user.photo.smallPhotoUrl")
ls_StandardEmailPhotoUrl = loo_JResp.StringOf("user.photo.standardEmailPhotoUrl")
ls_PhotoUrl = loo_JResp.StringOf("user.photo.url")
ls_Reputation = loo_JResp.StringOf("user.reputation")
ls_Title = loo_JResp.StringOf("user.title")
ls_V_Type = loo_JResp.StringOf("user.type")
ls_UserUrl = loo_JResp.StringOf("user.url")
ls_UserType = loo_JResp.StringOf("user.userType")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests

Postman Collection Item JSON

{
  "name": "Group Members—Private - POST",
  "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/requests",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "chatter",
        "groups",
        ":GROUP_ID",
        "members",
        "requests"
      ],
      "variable": [
        {
          "key": "GROUP_ID",
          "value": ""
        }
      ]
    },
    "description": "Request membership in a private group or get the status of requests to a join a private group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembersRequests.htm"
  },
  "response": [
    {
      "name": "Group Members—Private - POST",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "chatter",
            "groups",
            ":GROUP_ID",
            "members",
            "requests"
          ],
          "variable": [
            {
              "key": "GROUP_ID",
              "value": "0F9..."
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 Nov 2023 11:52:41 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    \"createdDate\": \"2023-11-22T11:52:41.000Z\",\n    \"id\": \"0I5...\",\n    \"lastUpdateDate\": \"2023-11-22T11:52:41.000Z\",\n    \"requestedGroup\": {\n        \"id\": \"0F9...\",\n        \"url\": \"/services/data/v58.0/chatter/groups/0F9...\"\n    },\n    \"responseMessage\": null,\n    \"status\": \"Pending\",\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}"
    }
  ]
}