unicodeCpp / Support API / Update Many Macros
Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"login");
http.put_Password(L"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.
// {
// "macros": [
// {
// "id": "<integer>",
// "active": "<boolean>",
// "position": "<integer>"
// },
// {
// "id": "<integer>",
// "active": "<boolean>",
// "position": "<integer>"
// }
// ]
// }
CkJsonObjectW json;
json.UpdateString(L"macros[0].id",L"<integer>");
json.UpdateString(L"macros[0].active",L"<boolean>");
json.UpdateString(L"macros[0].position",L"<integer>");
json.UpdateString(L"macros[1].id",L"<integer>");
json.UpdateString(L"macros[1].active",L"<boolean>");
json.UpdateString(L"macros[1].position",L"<integer>");
http.SetRequestHeader(L"Content-Type",L"application/json");
http.SetRequestHeader(L"Accept",L"application/json");
CkStringBuilderW sbRequestBody;
json.EmitSb(sbRequestBody);
CkHttpResponseW *resp = http.PTextSb(L"PUT",L"https://example.zendesk.com/api/v2/macros/update_many",sbRequestBody,L"utf-8",L"application/json",false,false);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "macros": [
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "proidentf9": true
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// },
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "deserunt_": false,
// "exercitation2": -75718943,
// "eiusmodeaf": 24563232.4790345,
// "estf5": "aute",
// "minim24": -78305859
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// }
// ],
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<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.
const wchar_t *title = 0;
const wchar_t *active = 0;
const wchar_t *created_at = 0;
const wchar_t *default = 0;
const wchar_t *description = 0;
const wchar_t *id = 0;
const wchar_t *position = 0;
bool Proidentf9;
const wchar_t *updated_at = 0;
const wchar_t *url = 0;
const wchar_t *app_installation = 0;
const wchar_t *categories = 0;
const wchar_t *permissions = 0;
const wchar_t *usage_1h = 0;
const wchar_t *usage_7d = 0;
const wchar_t *usage_24h = 0;
const wchar_t *usage_30d = 0;
bool Deserunt_;
int Exercitation2;
const wchar_t *Eiusmodeaf = 0;
const wchar_t *Estf5 = 0;
int Minim24;
int j;
int count_j;
const wchar_t *field = 0;
const wchar_t *value = 0;
const wchar_t *count = jResp.stringOf(L"count");
const wchar_t *next_page = jResp.stringOf(L"next_page");
const wchar_t *previous_page = jResp.stringOf(L"previous_page");
int i = 0;
int count_i = jResp.SizeOfArray(L"macros");
while (i < count_i) {
jResp.put_I(i);
title = jResp.stringOf(L"macros[i].title");
active = jResp.stringOf(L"macros[i].active");
created_at = jResp.stringOf(L"macros[i].created_at");
default = jResp.stringOf(L"macros[i].default");
description = jResp.stringOf(L"macros[i].description");
id = jResp.stringOf(L"macros[i].id");
position = jResp.stringOf(L"macros[i].position");
Proidentf9 = jResp.BoolOf(L"macros[i].restriction.proidentf9");
updated_at = jResp.stringOf(L"macros[i].updated_at");
url = jResp.stringOf(L"macros[i].url");
app_installation = jResp.stringOf(L"macros[i].app_installation");
categories = jResp.stringOf(L"macros[i].categories");
permissions = jResp.stringOf(L"macros[i].permissions");
usage_1h = jResp.stringOf(L"macros[i].usage_1h");
usage_7d = jResp.stringOf(L"macros[i].usage_7d");
usage_24h = jResp.stringOf(L"macros[i].usage_24h");
usage_30d = jResp.stringOf(L"macros[i].usage_30d");
Deserunt_ = jResp.BoolOf(L"macros[i].restriction.deserunt_");
Exercitation2 = jResp.IntOf(L"macros[i].restriction.exercitation2");
Eiusmodeaf = jResp.stringOf(L"macros[i].restriction.eiusmodeaf");
Estf5 = jResp.stringOf(L"macros[i].restriction.estf5");
Minim24 = jResp.IntOf(L"macros[i].restriction.minim24");
j = 0;
count_j = jResp.SizeOfArray(L"macros[i].actions");
while (j < count_j) {
jResp.put_J(j);
field = jResp.stringOf(L"macros[i].actions[j].field");
value = jResp.stringOf(L"macros[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 '{
"macros": [
{
"id": "<integer>",
"active": "<boolean>",
"position": "<integer>"
},
{
"id": "<integer>",
"active": "<boolean>",
"position": "<integer>"
}
]
}'
https://example.zendesk.com/api/v2/macros/update_many
Postman Collection Item JSON
{
"name": "Update Many Macros",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"macros\": [\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"position\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"position\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros/update_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"update_many"
]
},
"description": "Updates the provided macros with the specified changes.\n\n#### Allowed For\n* Agents\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 \"macros\": [\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"position\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"position\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros/update_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
"update_many"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"macros\": [\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 \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"proidentf9\": true\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\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 \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"deserunt_\": false,\n \"exercitation2\": -75718943,\n \"eiusmodeaf\": 24563232.4790345,\n \"estf5\": \"aute\",\n \"minim24\": -78305859\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
