TCL / Support API / Update Many Macros
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "macros": [
# {
# "id": "<integer>",
# "active": "<boolean>",
# "position": "<integer>"
# },
# {
# "id": "<integer>",
# "active": "<boolean>",
# "position": "<integer>"
# }
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "macros[0].id" "<integer>"
CkJsonObject_UpdateString $json "macros[0].active" "<boolean>"
CkJsonObject_UpdateString $json "macros[0].position" "<integer>"
CkJsonObject_UpdateString $json "macros[1].id" "<integer>"
CkJsonObject_UpdateString $json "macros[1].active" "<boolean>"
CkJsonObject_UpdateString $json "macros[1].position" "<integer>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
set resp [new_CkHttpResponse]
set success [CkHttp_HttpSb $http "PUT" "https://example.zendesk.com/api/v2/macros/update_many" $sbRequestBody "utf-8" "application/json" $resp]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "macros": [
# {
# "actions": [
# {
# "field": "<string>",
# "value": "<string>"
# },
# {
# "field": "<string>",
# "value": "<string>"
# }
# ],
# "title": "<string>",
# "active": "<boolean>",
# "created_at": "<dateTime>",
# "default": "<boolean>",
# "description": "<string>",
# "id": "<integer>",
# "position": "<integer>",
# "restriction": {
# "proidentf9": true
# },
# "updated_at": "<dateTime>",
# "url": "<string>",
# "app_installation": "<string>",
# "categories": "<string>",
# "permissions": "<string>",
# "usage_1h": "<integer>",
# "usage_7d": "<integer>",
# "usage_24h": "<integer>",
# "usage_30d": "<integer>"
# },
# {
# "actions": [
# {
# "field": "<string>",
# "value": "<string>"
# },
# {
# "field": "<string>",
# "value": "<string>"
# }
# ],
# "title": "<string>",
# "active": "<boolean>",
# "created_at": "<dateTime>",
# "default": "<boolean>",
# "description": "<string>",
# "id": "<integer>",
# "position": "<integer>",
# "restriction": {
# "deserunt_": false,
# "exercitation2": -75718943,
# "eiusmodeaf": 24563232.4790345,
# "estf5": "aute",
# "minim24": -78305859
# },
# "updated_at": "<dateTime>",
# "url": "<string>",
# "app_installation": "<string>",
# "categories": "<string>",
# "permissions": "<string>",
# "usage_1h": "<integer>",
# "usage_7d": "<integer>",
# "usage_24h": "<integer>",
# "usage_30d": "<integer>"
# }
# ],
# "count": "<integer>",
# "next_page": "<string>",
# "previous_page": "<string>"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set count [CkJsonObject_stringOf $jResp "count"]
set next_page [CkJsonObject_stringOf $jResp "next_page"]
set previous_page [CkJsonObject_stringOf $jResp "previous_page"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "macros"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set title [CkJsonObject_stringOf $jResp "macros[i].title"]
set active [CkJsonObject_stringOf $jResp "macros[i].active"]
set created_at [CkJsonObject_stringOf $jResp "macros[i].created_at"]
set default [CkJsonObject_stringOf $jResp "macros[i].default"]
set description [CkJsonObject_stringOf $jResp "macros[i].description"]
set id [CkJsonObject_stringOf $jResp "macros[i].id"]
set position [CkJsonObject_stringOf $jResp "macros[i].position"]
set Proidentf9 [CkJsonObject_BoolOf $jResp "macros[i].restriction.proidentf9"]
set updated_at [CkJsonObject_stringOf $jResp "macros[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "macros[i].url"]
set app_installation [CkJsonObject_stringOf $jResp "macros[i].app_installation"]
set categories [CkJsonObject_stringOf $jResp "macros[i].categories"]
set permissions [CkJsonObject_stringOf $jResp "macros[i].permissions"]
set usage_1h [CkJsonObject_stringOf $jResp "macros[i].usage_1h"]
set usage_7d [CkJsonObject_stringOf $jResp "macros[i].usage_7d"]
set usage_24h [CkJsonObject_stringOf $jResp "macros[i].usage_24h"]
set usage_30d [CkJsonObject_stringOf $jResp "macros[i].usage_30d"]
set Deserunt_ [CkJsonObject_BoolOf $jResp "macros[i].restriction.deserunt_"]
set Exercitation2 [CkJsonObject_IntOf $jResp "macros[i].restriction.exercitation2"]
set Eiusmodeaf [CkJsonObject_stringOf $jResp "macros[i].restriction.eiusmodeaf"]
set Estf5 [CkJsonObject_stringOf $jResp "macros[i].restriction.estf5"]
set Minim24 [CkJsonObject_IntOf $jResp "macros[i].restriction.minim24"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "macros[i].actions"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set field [CkJsonObject_stringOf $jResp "macros[i].actions[j].field"]
set value [CkJsonObject_stringOf $jResp "macros[i].actions[j].value"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"macros": [
{
"id": "<integer>",
"active": "<boolean>",
"position": "<integer>"
},
{
"id": "<integer>",
"active": "<boolean>",
"position": "<integer>"
}
]
}'
https://example.zendesk.com/api/v2/macros/update_many
Postman Collection Item JSON
{
"name": "Update Many Macros",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"macros\": [\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"position\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"position\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros/update_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"update_many"
]
},
"description": "Updates the provided macros with the specified changes.\n\n#### Allowed For\n* Agents\n"
},
"response": [
{
"name": "Success Response",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"macros\": [\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"position\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"position\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros/update_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"update_many"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"macros\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"proidentf9\": true\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"deserunt_\": false,\n \"exercitation2\": -75718943,\n \"eiusmodeaf\": 24563232.4790345,\n \"estf5\": \"aute\",\n \"minim24\": -78305859\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
