Chilkat Tools

lianja / Support API / Update Many Automations

// 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"

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/automations/update_many")
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    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 loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("automations")
do while i < lnCount_i
    loJResp.I = i
    lcActive = loJResp.StringOf("automations[i].active")
    lcCreated_at = loJResp.StringOf("automations[i].created_at")
    lcDefault = loJResp.StringOf("automations[i].default")
    lcId = loJResp.StringOf("automations[i].id")
    lcPosition = loJResp.StringOf("automations[i].position")
    lcRaw_title = loJResp.StringOf("automations[i].raw_title")
    lcTitle = loJResp.StringOf("automations[i].title")
    lcUpdated_at = loJResp.StringOf("automations[i].updated_at")
    j = 0
    lnCount_j = loJResp.SizeOfArray("automations[i].actions")
    do while j < lnCount_j
        loJResp.J = j
        lcField = loJResp.StringOf("automations[i].actions[j].field")
        lcValue = loJResp.StringOf("automations[i].actions[j].value")
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJResp.SizeOfArray("automations[i].conditions.all")
    do while j < lnCount_j
        loJResp.J = j
        lcField = loJResp.StringOf("automations[i].conditions.all[j].field")
        lcOperator = loJResp.StringOf("automations[i].conditions.all[j].operator")
        lcValue = loJResp.StringOf("automations[i].conditions.all[j].value")
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJResp.SizeOfArray("automations[i].conditions.any")
    do while j < lnCount_j
        loJResp.J = j
        lcField = loJResp.StringOf("automations[i].conditions.any[j].field")
        lcOperator = loJResp.StringOf("automations[i].conditions.any[j].operator")
        lcValue = loJResp.StringOf("automations[i].conditions.any[j].value")
        j = j + 1
    enddo
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

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}"
    }
  ]
}

Chilkat Online Tools

lianja / Support API / Update Many Automations

Curl Command

Postman Collection Item JSON