C / Support API / Update Many Triggers
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *title;
const char *active;
const char *category_id;
const char *created_at;
const char *default;
const char *description;
const char *id;
const char *position;
const char *raw_title;
const char *updated_at;
const char *url;
int j;
int count_j;
const char *field;
const char *operator;
const char *value;
const char *count;
const char *next_page;
const char *previous_page;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"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 = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"triggers[0].id","<integer>");
CkJsonObject_UpdateString(json,"triggers[0].active","<boolean>");
CkJsonObject_UpdateString(json,"triggers[0].category_id","<string>");
CkJsonObject_UpdateString(json,"triggers[0].position","<integer>");
CkJsonObject_UpdateString(json,"triggers[1].id","<integer>");
CkJsonObject_UpdateString(json,"triggers[1].active","<boolean>");
CkJsonObject_UpdateString(json,"triggers[1].category_id","<string>");
CkJsonObject_UpdateString(json,"triggers[1].position","<integer>");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp = CkHttp_PTextSb(http,"PUT","https://example.zendesk.com/api/v2/triggers/update_many",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
count = CkJsonObject_stringOf(jResp,"count");
next_page = CkJsonObject_stringOf(jResp,"next_page");
previous_page = CkJsonObject_stringOf(jResp,"previous_page");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"triggers");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
title = CkJsonObject_stringOf(jResp,"triggers[i].title");
active = CkJsonObject_stringOf(jResp,"triggers[i].active");
category_id = CkJsonObject_stringOf(jResp,"triggers[i].category_id");
created_at = CkJsonObject_stringOf(jResp,"triggers[i].created_at");
default = CkJsonObject_stringOf(jResp,"triggers[i].default");
description = CkJsonObject_stringOf(jResp,"triggers[i].description");
id = CkJsonObject_stringOf(jResp,"triggers[i].id");
position = CkJsonObject_stringOf(jResp,"triggers[i].position");
raw_title = CkJsonObject_stringOf(jResp,"triggers[i].raw_title");
updated_at = CkJsonObject_stringOf(jResp,"triggers[i].updated_at");
url = CkJsonObject_stringOf(jResp,"triggers[i].url");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"triggers[i].conditions.all");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
field = CkJsonObject_stringOf(jResp,"triggers[i].conditions.all[j].field");
operator = CkJsonObject_stringOf(jResp,"triggers[i].conditions.all[j].operator");
value = CkJsonObject_stringOf(jResp,"triggers[i].conditions.all[j].value");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"triggers[i].conditions.any");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
field = CkJsonObject_stringOf(jResp,"triggers[i].conditions.any[j].field");
operator = CkJsonObject_stringOf(jResp,"triggers[i].conditions.any[j].operator");
value = CkJsonObject_stringOf(jResp,"triggers[i].conditions.any[j].value");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"triggers[i].actions");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
field = CkJsonObject_stringOf(jResp,"triggers[i].actions[j].field");
value = CkJsonObject_stringOf(jResp,"triggers[i].actions[j].value");
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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}"
}
]
}
