Xojo / 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.
Dim http As New Chilkat.Http
Dim success As Boolean
http.BasicAuth = True
http.Login = "login"
http.Password = "password"
http.SetRequestHeader "Accept","application/json"
Dim resp As Chilkat.HttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/automations/update_many")
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim active As String
Dim created_at As String
Dim default As String
Dim id As String
Dim position As String
Dim raw_title As String
Dim title As String
Dim updated_at As String
Dim j As Int32
Dim count_j As Int32
Dim field As String
Dim value As String
Dim operator As String
Dim count As String
count = jResp.StringOf("count")
Dim next_page As String
next_page = jResp.StringOf("next_page")
Dim previous_page As String
previous_page = jResp.StringOf("previous_page")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("automations")
While i < count_i
jResp.I = i
active = jResp.StringOf("automations[i].active")
created_at = jResp.StringOf("automations[i].created_at")
default = jResp.StringOf("automations[i].default")
id = jResp.StringOf("automations[i].id")
position = jResp.StringOf("automations[i].position")
raw_title = jResp.StringOf("automations[i].raw_title")
title = jResp.StringOf("automations[i].title")
updated_at = jResp.StringOf("automations[i].updated_at")
j = 0
count_j = jResp.SizeOfArray("automations[i].actions")
While j < count_j
jResp.J = j
field = jResp.StringOf("automations[i].actions[j].field")
value = jResp.StringOf("automations[i].actions[j].value")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("automations[i].conditions.all")
While j < count_j
jResp.J = j
field = jResp.StringOf("automations[i].conditions.all[j].field")
operator = jResp.StringOf("automations[i].conditions.all[j].operator")
value = jResp.StringOf("automations[i].conditions.all[j].value")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("automations[i].conditions.any")
While j < count_j
jResp.J = j
field = jResp.StringOf("automations[i].conditions.any[j].field")
operator = jResp.StringOf("automations[i].conditions.any[j].operator")
value = jResp.StringOf("automations[i].conditions.any[j].value")
j = j + 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}"
}
]
}
