Chilkat Online Tools

SQL Server / Salesforce Platform APIs / Following - POST

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'POST', 'https://domain.com/services/data/v{{version}}/chatter/users/:USER_ID/following?subjectId=<RECORD_ID>'
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    DECLARE @sbResponseBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jResp int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

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

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

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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}"
    }
  ]
}