Chilkat Online Tools

Ruby / Salesforce Platform APIs / Following - POST

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://domain.com/services/data/v{{version}}/chatter/users/:USER_ID/following?subjectId=<RECORD_ID>")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "community": null,
#   "id": "0E8...",
#   "subject": {
#     "entityLabel": {
#       "label": "Account",
#       "labelPlural": "Accounts"
#     },
#     "id": "001...",
#     "motif": {
#       "color": "5867E8",
#       "largeIconUrl": "/img/icon/accounts64.png",
#       "mediumIconUrl": "/img/icon/accounts32.png",
#       "smallIconUrl": "/img/icon/accounts16.png",
#       "svgIconUrl": null
#     },
#     "mySubscription": null,
#     "name": "Exemple de comptes pour les autorisations",
#     "type": "Account",
#     "url": "/services/data/v58.0/chatter/records/001..."
#   },
#   "subscriber": {
#     "additionalLabel": null,
#     "communityNickname": "integration1.4407085834085586E12",
#     "companyName": "Salesforce",
#     "displayName": "Integration User",
#     "firstName": "Integration",
#     "id": "005...",
#     "isActive": true,
#     "isInThisCommunity": true,
#     "lastName": "User",
#     "motif": {
#       "color": "1B96FF",
#       "largeIconUrl": "/img/icon/profile64.png",
#       "mediumIconUrl": "/img/icon/profile32.png",
#       "smallIconUrl": "/img/icon/profile16.png",
#       "svgIconUrl": null
#     },
#     "mySubscription": null,
#     "name": "Integration User",
#     "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"
#   },
#   "url": "/services/data/v58.0/chatter/subscriptions/0E8..."
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

community = jResp.stringOf("community")
id = jResp.stringOf("id")
Label = jResp.stringOf("subject.entityLabel.label")
LabelPlural = jResp.stringOf("subject.entityLabel.labelPlural")
Id = jResp.stringOf("subject.id")
Color = jResp.stringOf("subject.motif.color")
LargeIconUrl = jResp.stringOf("subject.motif.largeIconUrl")
MediumIconUrl = jResp.stringOf("subject.motif.mediumIconUrl")
SmallIconUrl = jResp.stringOf("subject.motif.smallIconUrl")
SvgIconUrl = jResp.stringOf("subject.motif.svgIconUrl")
MySubscription = jResp.stringOf("subject.mySubscription")
Name = jResp.stringOf("subject.name")
v_Type = jResp.stringOf("subject.type")
v_Url = jResp.stringOf("subject.url")
AdditionalLabel = jResp.stringOf("subscriber.additionalLabel")
CommunityNickname = jResp.stringOf("subscriber.communityNickname")
CompanyName = jResp.stringOf("subscriber.companyName")
DisplayName = jResp.stringOf("subscriber.displayName")
FirstName = jResp.stringOf("subscriber.firstName")
subscriberId = jResp.stringOf("subscriber.id")
IsActive = jResp.BoolOf("subscriber.isActive")
IsInThisCommunity = jResp.BoolOf("subscriber.isInThisCommunity")
LastName = jResp.stringOf("subscriber.lastName")
MotifColor = jResp.stringOf("subscriber.motif.color")
MotifLargeIconUrl = jResp.stringOf("subscriber.motif.largeIconUrl")
MotifMediumIconUrl = jResp.stringOf("subscriber.motif.mediumIconUrl")
MotifSmallIconUrl = jResp.stringOf("subscriber.motif.smallIconUrl")
MotifSvgIconUrl = jResp.stringOf("subscriber.motif.svgIconUrl")
subscriberMySubscription = jResp.stringOf("subscriber.mySubscription")
subscriberName = jResp.stringOf("subscriber.name")
Message = jResp.stringOf("subscriber.outOfOffice.message")
FullEmailPhotoUrl = jResp.stringOf("subscriber.photo.fullEmailPhotoUrl")
LargePhotoUrl = jResp.stringOf("subscriber.photo.largePhotoUrl")
MediumPhotoUrl = jResp.stringOf("subscriber.photo.mediumPhotoUrl")
PhotoVersionId = jResp.stringOf("subscriber.photo.photoVersionId")
SmallPhotoUrl = jResp.stringOf("subscriber.photo.smallPhotoUrl")
StandardEmailPhotoUrl = jResp.stringOf("subscriber.photo.standardEmailPhotoUrl")
PhotoUrl = jResp.stringOf("subscriber.photo.url")
Reputation = jResp.stringOf("subscriber.reputation")
Title = jResp.stringOf("subscriber.title")
subscriberType = jResp.stringOf("subscriber.type")
subscriberUrl = jResp.stringOf("subscriber.url")
UserType = jResp.stringOf("subscriber.userType")
url = jResp.stringOf("url")

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/users/:USER_ID/following?subjectId=<RECORD_ID>

Postman Collection Item JSON

{
  "name": "Following - 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/users/:USER_ID/following?subjectId=<RECORD_ID>",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "chatter",
        "users",
        ":USER_ID",
        "following"
      ],
      "query": [
        {
          "key": "subjectId",
          "value": "<RECORD_ID>"
        }
      ],
      "variable": [
        {
          "key": "USER_ID",
          "value": ""
        }
      ]
    },
    "description": "Returns a list of people, groups, records, topics, and files that the specified user is following. Also used to follow records.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_FollowingUsers.htm?search_text=following"
  },
  "response": [
    {
      "name": "Successful Following - POST",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/:USER_ID/following?subjectId=0012o00003O9lADAAZ",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "chatter",
            "users",
            ":USER_ID",
            "following"
          ],
          "query": [
            {
              "key": "subjectId",
              "value": "0012o00003O9lADAAZ"
            }
          ],
          "variable": [
            {
              "key": "USER_ID",
              "value": "0052o00000DKQarAAH"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:27:09 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    \"community\": null,\n    \"id\": \"0E8...\",\n    \"subject\": {\n        \"entityLabel\": {\n            \"label\": \"Account\",\n            \"labelPlural\": \"Accounts\"\n        },\n        \"id\": \"001...\",\n        \"motif\": {\n            \"color\": \"5867E8\",\n            \"largeIconUrl\": \"/img/icon/accounts64.png\",\n            \"mediumIconUrl\": \"/img/icon/accounts32.png\",\n            \"smallIconUrl\": \"/img/icon/accounts16.png\",\n            \"svgIconUrl\": null\n        },\n        \"mySubscription\": null,\n        \"name\": \"Exemple de comptes pour les autorisations\",\n        \"type\": \"Account\",\n        \"url\": \"/services/data/v58.0/chatter/records/001...\"\n    },\n    \"subscriber\": {\n        \"additionalLabel\": null,\n        \"communityNickname\": \"integration1.4407085834085586E12\",\n        \"companyName\": \"Salesforce\",\n        \"displayName\": \"Integration User\",\n        \"firstName\": \"Integration\",\n        \"id\": \"005...\",\n        \"isActive\": true,\n        \"isInThisCommunity\": true,\n        \"lastName\": \"User\",\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\": \"Integration User\",\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    \"url\": \"/services/data/v58.0/chatter/subscriptions/0E8...\"\n}"
    }
  ]
}