Chilkat Online Tools

autoit / Support API / Update Many Automations

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"

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/automations/update_many")
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)

; {
;   "automations": [
;     {
;       "actions": [
;         {
;           "field": "<string>",
;           "value": "<string>"
;         },
;         {
;           "field": "<string>",
;           "value": "<string>"
;         }
;       ],
;       "active": "<boolean>",
;       "conditions": {
;         "all": [
;           {
;             "field": "<string>",
;             "operator": "<string>",
;             "value": "<string>"
;           },
;           {
;             "field": "<string>",
;             "operator": "<string>",
;             "value": "<string>"
;           }
;         ],
;         "any": [
;           {
;             "field": "<string>",
;             "operator": "<string>",
;             "value": "<string>"
;           },
;           {
;             "field": "<string>",
;             "operator": "<string>",
;             "value": "<string>"
;           }
;         ]
;       },
;       "created_at": "<dateTime>",
;       "default": "<boolean>",
;       "id": "<integer>",
;       "position": "<integer>",
;       "raw_title": "<string>",
;       "title": "<string>",
;       "updated_at": "<dateTime>"
;     },
;     {
;       "actions": [
;         {
;           "field": "<string>",
;           "value": "<string>"
;         },
;         {
;           "field": "<string>",
;           "value": "<string>"
;         }
;       ],
;       "active": "<boolean>",
;       "conditions": {
;         "all": [
;           {
;             "field": "<string>",
;             "operator": "<string>",
;             "value": "<string>"
;           },
;           {
;             "field": "<string>",
;             "operator": "<string>",
;             "value": "<string>"
;           }
;         ],
;         "any": [
;           {
;             "field": "<string>",
;             "operator": "<string>",
;             "value": "<string>"
;           },
;           {
;             "field": "<string>",
;             "operator": "<string>",
;             "value": "<string>"
;           }
;         ]
;       },
;       "created_at": "<dateTime>",
;       "default": "<boolean>",
;       "id": "<integer>",
;       "position": "<integer>",
;       "raw_title": "<string>",
;       "title": "<string>",
;       "updated_at": "<dateTime>"
;     }
;   ],
;   "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 $sActive
Local $sCreated_at
Local $sDefault
Local $sId
Local $sPosition
Local $sRaw_title
Local $sTitle
Local $sUpdated_at
Local $iJ
Local $iCount_j
Local $sField
Local $sValue
Local $sOperator

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("automations")
While $i < $iCount_i
    $oJResp.I = $i
    $sActive = $oJResp.StringOf("automations[i].active")
    $sCreated_at = $oJResp.StringOf("automations[i].created_at")
    $sDefault = $oJResp.StringOf("automations[i].default")
    $sId = $oJResp.StringOf("automations[i].id")
    $sPosition = $oJResp.StringOf("automations[i].position")
    $sRaw_title = $oJResp.StringOf("automations[i].raw_title")
    $sTitle = $oJResp.StringOf("automations[i].title")
    $sUpdated_at = $oJResp.StringOf("automations[i].updated_at")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("automations[i].actions")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sField = $oJResp.StringOf("automations[i].actions[j].field")
        $sValue = $oJResp.StringOf("automations[i].actions[j].value")
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("automations[i].conditions.all")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sField = $oJResp.StringOf("automations[i].conditions.all[j].field")
        $sOperator = $oJResp.StringOf("automations[i].conditions.all[j].operator")
        $sValue = $oJResp.StringOf("automations[i].conditions.all[j].value")
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("automations[i].conditions.any")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sField = $oJResp.StringOf("automations[i].conditions.any[j].field")
        $sOperator = $oJResp.StringOf("automations[i].conditions.any[j].operator")
        $sValue = $oJResp.StringOf("automations[i].conditions.any[j].value")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/automations/update_many

Postman Collection Item JSON

{
  "name": "Update Many Automations",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/automations/update_many",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "automations",
        "update_many"
      ]
    },
    "description": "**Note**: You might be restricted from updating some default automations. If included in a bulk update, the unrestricted automations will be updated.\n\n#### Allowed For\n\n* Agents\n\n#### Request Parameters\n\nThe PUT request expects an `automations` object that lists the automations to update.\n\nEach automation may have the following properties:\n\n| Name     | Mandatory | Description\n| -------- | --------- | -----------\n| id       | yes       | The ID of the automation to update\n| position | no        | The new position of the automation\n| active   | no        | The active status of the automation (true or false)\n\n#### Example Request\n\n```js\n{\n  \"automations\": [\n    {\"id\": 25, \"position\": 3},\n    {\"id\": 23, \"position\": 5},\n    {\"id\": 27, \"position\": 9},\n    {\"id\": 22, \"position\": 7}\n  ]\n}\n```\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/automations/update_many",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "automations",
            "update_many"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"automations\": [\n    {\n      \"actions\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"active\": \"<boolean>\",\n      \"conditions\": {\n        \"all\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"any\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ]\n      },\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"raw_title\": \"<string>\",\n      \"title\": \"<string>\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    {\n      \"actions\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"active\": \"<boolean>\",\n      \"conditions\": {\n        \"all\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"any\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ]\n      },\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"raw_title\": \"<string>\",\n      \"title\": \"<string>\",\n      \"updated_at\": \"<dateTime>\"\n    }\n  ],\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}