Foxpro / Support API / Update Automation
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcField
LOCAL lcValue
LOCAL lcOperator
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_title
LOCAL lcTitle
LOCAL lcUpdated_at
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/automations/:automation_id")
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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
CANCEL
ENDIF
RELEASE loResp
* 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
lcActive = loJResp.StringOf("automation.active")
lcCreated_at = loJResp.StringOf("automation.created_at")
lcDefault = loJResp.StringOf("automation.default")
lcId = loJResp.StringOf("automation.id")
lcPosition = loJResp.StringOf("automation.position")
lcRaw_title = loJResp.StringOf("automation.raw_title")
lcTitle = loJResp.StringOf("automation.title")
lcUpdated_at = loJResp.StringOf("automation.updated_at")
i = 0
lnCount_i = loJResp.SizeOfArray("automation.actions")
DO WHILE i < lnCount_i
loJResp.I = i
lcField = loJResp.StringOf("automation.actions[i].field")
lcValue = loJResp.StringOf("automation.actions[i].value")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("automation.conditions.all")
DO WHILE i < lnCount_i
loJResp.I = i
lcField = loJResp.StringOf("automation.conditions.all[i].field")
lcOperator = loJResp.StringOf("automation.conditions.all[i].operator")
lcValue = loJResp.StringOf("automation.conditions.all[i].value")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("automation.conditions.any")
DO WHILE i < lnCount_i
loJResp.I = i
lcField = loJResp.StringOf("automation.conditions.any[i].field")
lcOperator = loJResp.StringOf("automation.conditions.any[i].operator")
lcValue = loJResp.StringOf("automation.conditions.any[i].value")
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/: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}"
}
]
}
