Powershell / Support API / Update Many Triggers
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "triggers": [
# {
# "id": "<integer>",
# "active": "<boolean>",
# "category_id": "<string>",
# "position": "<integer>"
# },
# {
# "id": "<integer>",
# "active": "<boolean>",
# "category_id": "<string>",
# "position": "<integer>"
# }
# ]
# }
$json = New-Object Chilkat.JsonObject
$json.UpdateString("triggers[0].id","<integer>")
$json.UpdateString("triggers[0].active","<boolean>")
$json.UpdateString("triggers[0].category_id","<string>")
$json.UpdateString("triggers[0].position","<integer>")
$json.UpdateString("triggers[1].id","<integer>")
$json.UpdateString("triggers[1].active","<boolean>")
$json.UpdateString("triggers[1].category_id","<string>")
$json.UpdateString("triggers[1].position","<integer>")
$http.SetRequestHeader("Content-Type","application/json")
$http.SetRequestHeader("Accept","application/json")
$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$resp = $http.PTextSb("PUT","https://example.zendesk.com/api/v2/triggers/update_many",$sbRequestBody,"utf-8","application/json",$false,$false)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "count": "<integer>",
# "next_page": "<string>",
# "previous_page": "<string>",
# "triggers": [
# {
# "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>"
# },
# {
# "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
$count = $jResp.StringOf("count")
$next_page = $jResp.StringOf("next_page")
$previous_page = $jResp.StringOf("previous_page")
$i = 0
$count_i = $jResp.SizeOfArray("triggers")
while ($i -lt $count_i) {
$jResp.I = $i
$title = $jResp.StringOf("triggers[i].title")
$active = $jResp.StringOf("triggers[i].active")
$category_id = $jResp.StringOf("triggers[i].category_id")
$created_at = $jResp.StringOf("triggers[i].created_at")
$default = $jResp.StringOf("triggers[i].default")
$description = $jResp.StringOf("triggers[i].description")
$id = $jResp.StringOf("triggers[i].id")
$position = $jResp.StringOf("triggers[i].position")
$raw_title = $jResp.StringOf("triggers[i].raw_title")
$updated_at = $jResp.StringOf("triggers[i].updated_at")
$url = $jResp.StringOf("triggers[i].url")
$j = 0
$count_j = $jResp.SizeOfArray("triggers[i].conditions.all")
while ($j -lt $count_j) {
$jResp.J = $j
$field = $jResp.StringOf("triggers[i].conditions.all[j].field")
$operator = $jResp.StringOf("triggers[i].conditions.all[j].operator")
$value = $jResp.StringOf("triggers[i].conditions.all[j].value")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("triggers[i].conditions.any")
while ($j -lt $count_j) {
$jResp.J = $j
$field = $jResp.StringOf("triggers[i].conditions.any[j].field")
$operator = $jResp.StringOf("triggers[i].conditions.any[j].operator")
$value = $jResp.StringOf("triggers[i].conditions.any[j].value")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("triggers[i].actions")
while ($j -lt $count_j) {
$jResp.J = $j
$field = $jResp.StringOf("triggers[i].actions[j].field")
$value = $jResp.StringOf("triggers[i].actions[j].value")
$j = $j + 1
}
$i = $i + 1
}
Curl Command
curl -u login:password -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"triggers": [
{
"id": "<integer>",
"active": "<boolean>",
"category_id": "<string>",
"position": "<integer>"
},
{
"id": "<integer>",
"active": "<boolean>",
"category_id": "<string>",
"position": "<integer>"
}
]
}'
https://example.zendesk.com/api/v2/triggers/update_many
Postman Collection Item JSON
{
"name": "Update Many Triggers",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"triggers\": [\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"category_id\": \"<string>\",\n \"position\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"category_id\": \"<string>\",\n \"position\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/update_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"update_many"
]
},
"description": "Updates the position or the active status of multiple triggers. Any additional properties are ignored.\n\n#### Allowed For\n\n* Agents\n\n#### Request Parameters\n\nThe PUT request expects a `triggers` object that lists the triggers to update.\n\nEach trigger may have the following properties:\n\n| Name | Mandatory | Description\n| -------- | --------- | -----------\n| id | yes | The ID of the trigger to update\n| position | no | The new position of the trigger\n| active | no | The active status of the trigger (true or false)\n| category_id | no | The ID of the new category the trigger is to be moved to\n\n#### Example Request\n\n```js\n{\n \"triggers\": [\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": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"triggers\": [\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"category_id\": \"<string>\",\n \"position\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"category_id\": \"<string>\",\n \"position\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/update_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"update_many"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"triggers\": [\n {\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 {\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 ]\n}"
}
]
}
