Chilkat Online Tools

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

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    var resp: CkoHttpResponse? = http.QuickRequest("POST", url: "https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests")
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

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