Chilkat Online Tools

C++ / Salesforce Platform APIs / Update a Favorite

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>

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

    CkHttp http;
    bool success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "name": "Red Accounts",
    //   "sortOrder": 1
    // }

    CkJsonObject json;
    json.UpdateString("name","Red Accounts");
    json.UpdateInt("sortOrder",1);

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

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "accessCount": 1,
    //   "iconColor": "5867E8",
    //   "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
    //   "id": "0MV4H0000004qIeWAI",
    //   "lastAccessDate": "2023-10-06T10:03:32.000Z",
    //   "name": "AllAccountsListViewFavoriteRenamed",
    //   "objectType": "Account",
    //   "sortOrder": 1,
    //   "subtitle": "Accounts",
    //   "target": "00B58000002ssinEAA",
    //   "targetType": "ListView"
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    int accessCount = jResp.IntOf("accessCount");
    const char *iconColor = jResp.stringOf("iconColor");
    const char *iconUrl = jResp.stringOf("iconUrl");
    const char *id = jResp.stringOf("id");
    const char *lastAccessDate = jResp.stringOf("lastAccessDate");
    const char *name = jResp.stringOf("name");
    const char *objectType = jResp.stringOf("objectType");
    int sortOrder = jResp.IntOf("sortOrder");
    const char *subtitle = jResp.stringOf("subtitle");
    const char *target = jResp.stringOf("target");
    const char *targetType = jResp.stringOf("targetType");
    }

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-d '{
  "name": "Red Accounts",
  "sortOrder": 1
}'
https://domain.com/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID

Postman Collection Item JSON

{
  "name": "Update a Favorite",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\": \"Red Accounts\",\n  \"sortOrder\": 1\n}\n",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "favorites",
        ":FAVORITE_ID"
      ],
      "variable": [
        {
          "key": "FAVORITE_ID",
          "value": "",
          "description": "The ID of a favorite"
        }
      ]
    },
    "description": "Update a Favorite"
  },
  "response": [
    {
      "name": "Update a Favorite",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"name\": \"AllAccountsListViewFavoriteRenamed\",\n  \"sortOrder\": 1\n}\n",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "favorites",
            ":FAVORITE_ID"
          ],
          "variable": [
            {
              "key": "FAVORITE_ID",
              "value": "0MV4H0000004qIeWAI",
              "description": "The ID of a favorite"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:06:33 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "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": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"accessCount\": 1,\n    \"iconColor\": \"5867E8\",\n    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n    \"id\": \"0MV4H0000004qIeWAI\",\n    \"lastAccessDate\": \"2023-10-06T10:03:32.000Z\",\n    \"name\": \"AllAccountsListViewFavoriteRenamed\",\n    \"objectType\": \"Account\",\n    \"sortOrder\": 1,\n    \"subtitle\": \"Accounts\",\n    \"target\": \"00B58000002ssinEAA\",\n    \"targetType\": \"ListView\"\n}"
    }
  ]
}