autoit / 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.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.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>"
; }
; ]
; }
$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("macros[0].id","<integer>")
$oJson.UpdateString("macros[0].active","<boolean>")
$oJson.UpdateString("macros[0].position","<integer>")
$oJson.UpdateString("macros[1].id","<integer>")
$oJson.UpdateString("macros[1].active","<boolean>")
$oJson.UpdateString("macros[1].position","<integer>")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbRequestBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/macros/update_many",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sTitle
Local $sActive
Local $sCreated_at
Local $sDefault
Local $sDescription
Local $sId
Local $sPosition
Local $bProidentf9
Local $sUpdated_at
Local $sUrl
Local $sApp_installation
Local $sCategories
Local $sPermissions
Local $sUsage_1h
Local $sUsage_7d
Local $sUsage_24h
Local $sUsage_30d
Local $bDeserunt_
Local $iExercitation2
Local $sEiusmodeaf
Local $sEstf5
Local $iMinim24
Local $iJ
Local $iCount_j
Local $sField
Local $sValue
Local $sCount = $oJResp.StringOf("count")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $sPrevious_page = $oJResp.StringOf("previous_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("macros")
While $i < $iCount_i
$oJResp.I = $i
$sTitle = $oJResp.StringOf("macros[i].title")
$sActive = $oJResp.StringOf("macros[i].active")
$sCreated_at = $oJResp.StringOf("macros[i].created_at")
$sDefault = $oJResp.StringOf("macros[i].default")
$sDescription = $oJResp.StringOf("macros[i].description")
$sId = $oJResp.StringOf("macros[i].id")
$sPosition = $oJResp.StringOf("macros[i].position")
$bProidentf9 = $oJResp.BoolOf("macros[i].restriction.proidentf9")
$sUpdated_at = $oJResp.StringOf("macros[i].updated_at")
$sUrl = $oJResp.StringOf("macros[i].url")
$sApp_installation = $oJResp.StringOf("macros[i].app_installation")
$sCategories = $oJResp.StringOf("macros[i].categories")
$sPermissions = $oJResp.StringOf("macros[i].permissions")
$sUsage_1h = $oJResp.StringOf("macros[i].usage_1h")
$sUsage_7d = $oJResp.StringOf("macros[i].usage_7d")
$sUsage_24h = $oJResp.StringOf("macros[i].usage_24h")
$sUsage_30d = $oJResp.StringOf("macros[i].usage_30d")
$bDeserunt_ = $oJResp.BoolOf("macros[i].restriction.deserunt_")
$iExercitation2 = $oJResp.IntOf("macros[i].restriction.exercitation2")
$sEiusmodeaf = $oJResp.StringOf("macros[i].restriction.eiusmodeaf")
$sEstf5 = $oJResp.StringOf("macros[i].restriction.estf5")
$iMinim24 = $oJResp.IntOf("macros[i].restriction.minim24")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("macros[i].actions")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sField = $oJResp.StringOf("macros[i].actions[j].field")
$sValue = $oJResp.StringOf("macros[i].actions[j].value")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
