Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "favorites": [
// {
// "id": "0MVR00000004DhnOAE",
// "name": "Q4 Perf"
// }
// ]
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("favorites[0].id","0MVR00000004DhnOAE")
loJson.UpdateString("favorites[0].name","Q4 Perf")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://domain.com/services/data/v{{version}}/ui-api/favorites/batch",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "favorites": [
// {
// "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": "RenamedAllAcountsListView",
// "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
i = 0
lnCount_i = loJResp.SizeOfArray("favorites")
do while i < lnCount_i
loJResp.I = i
lnAccessCount = loJResp.IntOf("favorites[i].accessCount")
lcIconColor = loJResp.StringOf("favorites[i].iconColor")
lcIconUrl = loJResp.StringOf("favorites[i].iconUrl")
lcId = loJResp.StringOf("favorites[i].id")
lcLastAccessDate = loJResp.StringOf("favorites[i].lastAccessDate")
lcName = loJResp.StringOf("favorites[i].name")
lcObjectType = loJResp.StringOf("favorites[i].objectType")
lnSortOrder = loJResp.IntOf("favorites[i].sortOrder")
lcSubtitle = loJResp.StringOf("favorites[i].subtitle")
lcTarget = loJResp.StringOf("favorites[i].target")
lcTargetType = loJResp.StringOf("favorites[i].targetType")
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"favorites": [
{
"id": "0MVR00000004DhnOAE",
"name": "Q4 Perf"
}
]
}'
https://domain.com/services/data/v{{version}}/ui-api/favorites/batch
Postman Collection Item JSON
{
"name": "Update a Batch of Favorites",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"favorites\": [\n {\n \"id\": \"0MVR00000004DhnOAE\",\n \"name\": \"Q4 Perf\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/batch",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"favorites",
"batch"
]
},
"description": "Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted."
},
"response": [
{
"name": "Update a Batch of Favorites",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"favorites\": [\n {\n \"id\": \"0MV4H0000004qIeWAI\",\n \"name\": \"RenamedAllAcountsListView\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/batch",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"favorites",
"batch"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 10:07:35 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 \"favorites\": [\n {\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\": \"RenamedAllAcountsListView\",\n \"objectType\": \"Account\",\n \"sortOrder\": 1,\n \"subtitle\": \"Accounts\",\n \"target\": \"00B58000002ssinEAA\",\n \"targetType\": \"ListView\"\n }\n ]\n}"
}
]
}
