Xojo / Support API / Update Automation
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/:automation_id")
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)
// {
// "automation": {
// "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>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim field As String
Dim value As String
Dim operator As String
Dim Active As String
Active = jResp.StringOf("automation.active")
Dim Created_at As String
Created_at = jResp.StringOf("automation.created_at")
Dim Default As String
Default = jResp.StringOf("automation.default")
Dim Id As String
Id = jResp.StringOf("automation.id")
Dim Position As String
Position = jResp.StringOf("automation.position")
Dim Raw_title As String
Raw_title = jResp.StringOf("automation.raw_title")
Dim Title As String
Title = jResp.StringOf("automation.title")
Dim Updated_at As String
Updated_at = jResp.StringOf("automation.updated_at")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("automation.actions")
While i < count_i
jResp.I = i
field = jResp.StringOf("automation.actions[i].field")
value = jResp.StringOf("automation.actions[i].value")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("automation.conditions.all")
While i < count_i
jResp.I = i
field = jResp.StringOf("automation.conditions.all[i].field")
operator = jResp.StringOf("automation.conditions.all[i].operator")
value = jResp.StringOf("automation.conditions.all[i].value")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("automation.conditions.any")
While i < count_i
jResp.I = i
field = jResp.StringOf("automation.conditions.any[i].field")
operator = jResp.StringOf("automation.conditions.any[i].operator")
value = jResp.StringOf("automation.conditions.any[i].value")
i = i + 1
Wend
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/automations/:automation_id
Postman Collection Item JSON
{
"name": "Update Automation",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/automations/:automation_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations",
":automation_id"
],
"variable": [
{
"key": "automation_id",
"value": "<integer>"
}
]
},
"description": "Updates an automation.\n\nUpdated automations must be unique and have at least one condition that is true only once or an action that nullifies at least one of the conditions. Active automations can have overlapping conditions but can't be identical.\n\nThe request must include the following conditions in the `all` array:\n- At least one time-based condition\n- At least one condition that checks one of the following fields: 'status', 'type', 'group_id', 'assignee_id', or 'requester_id'\n\n**Note**: Updating a condition or action updates both the `conditions` and `actions` arrays, clearing all existing values of both arrays. Include all your conditions and actions when updating any condition or action.\n**Note**: You might be restricted from updating some default automations.\n\n#### Allowed For\n\n* Agents\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/:automation_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations",
":automation_id"
],
"variable": [
{
"key": "automation_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"automation\": {\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}"
}
]
}
