Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Chilkat.Http http = new Chilkat.Http();
bool success;
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.
// {
// "macro": {
// "title": "<string>",
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "active": "<boolean>",
// "description": "<string>",
// "restriction": {
// "id": "<integer>",
// "ids": [
// "<integer>",
// "<integer>"
// ],
// "type": "<string>",
// "dolore_dc": "velit irure",
// "ullamco368": 46888012
// }
// }
// }
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("macro.title","<string>");
json.UpdateString("macro.actions[0].field","<string>");
json.UpdateString("macro.actions[0].value","<string>");
json.UpdateString("macro.actions[1].field","<string>");
json.UpdateString("macro.actions[1].value","<string>");
json.UpdateString("macro.active","<boolean>");
json.UpdateString("macro.description","<string>");
json.UpdateString("macro.restriction.id","<integer>");
json.UpdateString("macro.restriction.ids[0]","<integer>");
json.UpdateString("macro.restriction.ids[1]","<integer>");
json.UpdateString("macro.restriction.type","<string>");
json.UpdateString("macro.restriction.dolore_dc","velit irure");
json.UpdateInt("macro.restriction.ullamco368",46888012);
http.SetRequestHeader("Content-Type","application/json");
http.SetRequestHeader("Accept","application/json");
Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);
Chilkat.HttpResponse resp = http.PTextSb("PUT","https://example.zendesk.com/api/v2/macros/:macro_id",sbRequestBody,"utf-8","application/json",false,false);
if (http.LastMethodSuccess == false) {
Debug.WriteLine(http.LastErrorText);
return;
}
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());
int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
Debug.WriteLine("Response Header:");
Debug.WriteLine(resp.Header);
Debug.WriteLine("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "macro": {
// "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": {
// "utc": -57663786.73485631,
// "sint_c": 56026975.00248328
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
string field;
string value;
string Title = jResp.StringOf("macro.title");
string Active = jResp.StringOf("macro.active");
string Created_at = jResp.StringOf("macro.created_at");
string Default = jResp.StringOf("macro.default");
string Description = jResp.StringOf("macro.description");
string Id = jResp.StringOf("macro.id");
string Position = jResp.StringOf("macro.position");
string Utc = jResp.StringOf("macro.restriction.utc");
string Sint_c = jResp.StringOf("macro.restriction.sint_c");
string Updated_at = jResp.StringOf("macro.updated_at");
string v_Url = jResp.StringOf("macro.url");
string App_installation = jResp.StringOf("macro.app_installation");
string Categories = jResp.StringOf("macro.categories");
string Permissions = jResp.StringOf("macro.permissions");
string Usage_1h = jResp.StringOf("macro.usage_1h");
string Usage_7d = jResp.StringOf("macro.usage_7d");
string Usage_24h = jResp.StringOf("macro.usage_24h");
string Usage_30d = jResp.StringOf("macro.usage_30d");
int i = 0;
int count_i = jResp.SizeOfArray("macro.actions");
while (i < count_i) {
jResp.I = i;
field = jResp.StringOf("macro.actions[i].field");
value = jResp.StringOf("macro.actions[i].value");
i = i + 1;
}
Curl Command
curl -u login:password -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"macro": {
"title": "<string>",
"actions": [
{
"field": "<string>",
"value": "<string>"
},
{
"field": "<string>",
"value": "<string>"
}
],
"active": "<boolean>",
"description": "<string>",
"restriction": {
"id": "<integer>",
"ids": [
"<integer>",
"<integer>"
],
"type": "<string>",
"dolore_dc": "velit irure",
"ullamco368": 46888012
}
}
}'
https://example.zendesk.com/api/v2/macros/:macro_id
Postman Collection Item JSON
{
"name": "Update Macro",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"macro\": {\n \"title\": \"<string>\",\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"description\": \"<string>\",\n \"restriction\": {\n \"id\": \"<integer>\",\n \"ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"type\": \"<string>\",\n \"dolore_dc\": \"velit irure\",\n \"ullamco368\": 46888012\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros/:macro_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id"
],
"variable": [
{
"key": "macro_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n* Agents\n"
},
"response": [
{
"name": "OK",
"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 \"macro\": {\n \"title\": \"<string>\",\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"description\": \"<string>\",\n \"restriction\": {\n \"id\": \"<integer>\",\n \"ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"type\": \"<string>\",\n \"dolore_dc\": \"velit irure\",\n \"ullamco368\": 46888012\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros/:macro_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id"
],
"variable": [
{
"key": "macro_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"macro\": {\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 \"utc\": -57663786.73485631,\n \"sint_c\": 56026975.00248328\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}"
}
]
}
