Chilkat Online Tools

Perl / Salesforce Platform APIs / Update a Favorite

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

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

$json = chilkat::CkJsonObject->new();
$json->UpdateString("name","Red Accounts");
$json->UpdateInt("sortOrder",1);

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

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PATCH","https://domain.com/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$accessCount = $jResp->IntOf("accessCount");
$iconColor = $jResp->stringOf("iconColor");
$iconUrl = $jResp->stringOf("iconUrl");
$id = $jResp->stringOf("id");
$lastAccessDate = $jResp->stringOf("lastAccessDate");
$name = $jResp->stringOf("name");
$objectType = $jResp->stringOf("objectType");
$sortOrder = $jResp->IntOf("sortOrder");
$subtitle = $jResp->stringOf("subtitle");
$target = $jResp->stringOf("target");
$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}"
    }
  ]
}