Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
// 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"
// }
// ]
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("favorites[0].id","0MVR00000004DhnOAE")
success = json.UpdateString("favorites[0].name","Q4 Perf")
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://domain.com/services/data/v{{version}}/ui-api/favorites/batch",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim accessCount As Int32
Dim iconColor As String
Dim iconUrl As String
Dim id As String
Dim lastAccessDate As String
Dim name As String
Dim objectType As String
Dim sortOrder As Int32
Dim subtitle As String
Dim target As String
Dim targetType As String
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("favorites")
While i < count_i
jResp.I = i
accessCount = jResp.IntOf("favorites[i].accessCount")
iconColor = jResp.StringOf("favorites[i].iconColor")
iconUrl = jResp.StringOf("favorites[i].iconUrl")
id = jResp.StringOf("favorites[i].id")
lastAccessDate = jResp.StringOf("favorites[i].lastAccessDate")
name = jResp.StringOf("favorites[i].name")
objectType = jResp.StringOf("favorites[i].objectType")
sortOrder = jResp.IntOf("favorites[i].sortOrder")
subtitle = jResp.StringOf("favorites[i].subtitle")
target = jResp.StringOf("favorites[i].target")
targetType = jResp.StringOf("favorites[i].targetType")
i = i + 1
Wend
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}"
}
]
}
