lianja / Support API / Update Many Macros
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")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "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>"
// }
// ]
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("macros[0].id","<integer>")
loJson.UpdateString("macros[0].active","<boolean>")
loJson.UpdateString("macros[0].position","<integer>")
loJson.UpdateString("macros[1].id","<integer>")
loJson.UpdateString("macros[1].active","<boolean>")
loJson.UpdateString("macros[1].position","<integer>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/macros/update_many",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)
// {
// "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
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("macros")
do while i < lnCount_i
loJResp.I = i
lcTitle = loJResp.StringOf("macros[i].title")
lcActive = loJResp.StringOf("macros[i].active")
lcCreated_at = loJResp.StringOf("macros[i].created_at")
lcDefault = loJResp.StringOf("macros[i].default")
lcDescription = loJResp.StringOf("macros[i].description")
lcId = loJResp.StringOf("macros[i].id")
lcPosition = loJResp.StringOf("macros[i].position")
llProidentf9 = loJResp.BoolOf("macros[i].restriction.proidentf9")
lcUpdated_at = loJResp.StringOf("macros[i].updated_at")
lcUrl = loJResp.StringOf("macros[i].url")
lcApp_installation = loJResp.StringOf("macros[i].app_installation")
lcCategories = loJResp.StringOf("macros[i].categories")
lcPermissions = loJResp.StringOf("macros[i].permissions")
lcUsage_1h = loJResp.StringOf("macros[i].usage_1h")
lcUsage_7d = loJResp.StringOf("macros[i].usage_7d")
lcUsage_24h = loJResp.StringOf("macros[i].usage_24h")
lcUsage_30d = loJResp.StringOf("macros[i].usage_30d")
llDeserunt_ = loJResp.BoolOf("macros[i].restriction.deserunt_")
lnExercitation2 = loJResp.IntOf("macros[i].restriction.exercitation2")
lcEiusmodeaf = loJResp.StringOf("macros[i].restriction.eiusmodeaf")
lcEstf5 = loJResp.StringOf("macros[i].restriction.estf5")
lnMinim24 = loJResp.IntOf("macros[i].restriction.minim24")
j = 0
lnCount_j = loJResp.SizeOfArray("macros[i].actions")
do while j < lnCount_j
loJResp.J = j
lcField = loJResp.StringOf("macros[i].actions[j].field")
lcValue = loJResp.StringOf("macros[i].actions[j].value")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
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}"
}
]
}
