Chilkat Online Tools

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

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequest("POST","https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests")
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim createdDate As String
createdDate = jResp.StringOf("createdDate")
Dim id As String
id = jResp.StringOf("id")
Dim lastUpdateDate As String
lastUpdateDate = jResp.StringOf("lastUpdateDate")
Dim Id As String
Id = jResp.StringOf("requestedGroup.id")
Dim v_Url As String
v_Url = jResp.StringOf("requestedGroup.url")
Dim responseMessage As String
responseMessage = jResp.StringOf("responseMessage")
Dim status As String
status = jResp.StringOf("status")
Dim url As String
url = jResp.StringOf("url")
Dim AdditionalLabel As String
AdditionalLabel = jResp.StringOf("user.additionalLabel")
Dim CommunityNickname As String
CommunityNickname = jResp.StringOf("user.communityNickname")
Dim CompanyName As String
CompanyName = jResp.StringOf("user.companyName")
Dim DisplayName As String
DisplayName = jResp.StringOf("user.displayName")
Dim FirstName As String
FirstName = jResp.StringOf("user.firstName")
Dim userId As String
userId = jResp.StringOf("user.id")
Dim IsActive As Long
IsActive = jResp.BoolOf("user.isActive")
Dim IsInThisCommunity As Long
IsInThisCommunity = jResp.BoolOf("user.isInThisCommunity")
Dim LastName As String
LastName = jResp.StringOf("user.lastName")
Dim Color As String
Color = jResp.StringOf("user.motif.color")
Dim LargeIconUrl As String
LargeIconUrl = jResp.StringOf("user.motif.largeIconUrl")
Dim MediumIconUrl As String
MediumIconUrl = jResp.StringOf("user.motif.mediumIconUrl")
Dim SmallIconUrl As String
SmallIconUrl = jResp.StringOf("user.motif.smallIconUrl")
Dim SvgIconUrl As String
SvgIconUrl = jResp.StringOf("user.motif.svgIconUrl")
Dim MySubscription As String
MySubscription = jResp.StringOf("user.mySubscription")
Dim Name As String
Name = jResp.StringOf("user.name")
Dim Message As String
Message = jResp.StringOf("user.outOfOffice.message")
Dim FullEmailPhotoUrl As String
FullEmailPhotoUrl = jResp.StringOf("user.photo.fullEmailPhotoUrl")
Dim LargePhotoUrl As String
LargePhotoUrl = jResp.StringOf("user.photo.largePhotoUrl")
Dim MediumPhotoUrl As String
MediumPhotoUrl = jResp.StringOf("user.photo.mediumPhotoUrl")
Dim PhotoVersionId As String
PhotoVersionId = jResp.StringOf("user.photo.photoVersionId")
Dim SmallPhotoUrl As String
SmallPhotoUrl = jResp.StringOf("user.photo.smallPhotoUrl")
Dim StandardEmailPhotoUrl As String
StandardEmailPhotoUrl = jResp.StringOf("user.photo.standardEmailPhotoUrl")
Dim PhotoUrl As String
PhotoUrl = jResp.StringOf("user.photo.url")
Dim Reputation As String
Reputation = jResp.StringOf("user.reputation")
Dim Title As String
Title = jResp.StringOf("user.title")
Dim v_Type As String
v_Type = jResp.StringOf("user.type")
Dim userUrl As String
userUrl = jResp.StringOf("user.url")
Dim UserType As String
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/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}"
    }
  ]
}