TCL / Support API / Reorder Triggers
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "PUT" "https://example.zendesk.com/api/v2/triggers/reorder"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "trigger": {
# "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>"
# }
# ]
# },
# "actions": [
# {
# "field": "<string>",
# "value": "<string>"
# },
# {
# "field": "<string>",
# "value": "<string>"
# }
# ],
# "title": "<string>",
# "active": "<boolean>",
# "category_id": "<string>",
# "created_at": "<string>",
# "default": "<boolean>",
# "description": "<string>",
# "id": "<integer>",
# "position": "<integer>",
# "raw_title": "<string>",
# "updated_at": "<string>",
# "url": "<string>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Title [CkJsonObject_stringOf $jResp "trigger.title"]
set Active [CkJsonObject_stringOf $jResp "trigger.active"]
set Category_id [CkJsonObject_stringOf $jResp "trigger.category_id"]
set Created_at [CkJsonObject_stringOf $jResp "trigger.created_at"]
set Default [CkJsonObject_stringOf $jResp "trigger.default"]
set Description [CkJsonObject_stringOf $jResp "trigger.description"]
set Id [CkJsonObject_stringOf $jResp "trigger.id"]
set Position [CkJsonObject_stringOf $jResp "trigger.position"]
set Raw_title [CkJsonObject_stringOf $jResp "trigger.raw_title"]
set Updated_at [CkJsonObject_stringOf $jResp "trigger.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "trigger.url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "trigger.conditions.all"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set field [CkJsonObject_stringOf $jResp "trigger.conditions.all[i].field"]
set operator [CkJsonObject_stringOf $jResp "trigger.conditions.all[i].operator"]
set value [CkJsonObject_stringOf $jResp "trigger.conditions.all[i].value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "trigger.conditions.any"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set field [CkJsonObject_stringOf $jResp "trigger.conditions.any[i].field"]
set operator [CkJsonObject_stringOf $jResp "trigger.conditions.any[i].operator"]
set value [CkJsonObject_stringOf $jResp "trigger.conditions.any[i].value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "trigger.actions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set field [CkJsonObject_stringOf $jResp "trigger.actions[i].field"]
set value [CkJsonObject_stringOf $jResp "trigger.actions[i].value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers/reorder
Postman Collection Item JSON
{
"name": "Reorder Triggers",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/reorder",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"reorder"
]
},
"description": "Alters the firing order of triggers in the account. See\n[Reordering and sorting triggers](https://support.zendesk.com/hc/en-us/articles/115015696088)\nin the Zendesk Help Center. The firing order is set in a `trigger_ids` array in the request body.\n\nYou must include every trigger id in your account to reorder the triggers. If not, the endpoint will return 404 Forbidden.\n\nReordering triggers via the API is not permitted if you have more than one trigger category. If there is more than one\ntrigger category, the endpoint will return a `LimitOneCategory` error.\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/triggers/reorder",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"reorder"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"trigger\": {\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 \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"category_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
