Chilkat Tools

.NET Core C# / Support API / Update Many Macros

// 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.

// {
//   "macros": [
//     {
//       "id": "<integer>",
//       "active": "<boolean>",
//       "position": "<integer>"
//     },
//     {
//       "id": "<integer>",
//       "active": "<boolean>",
//       "position": "<integer>"
//     }
//   ]
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("macros[0].id","<integer>");
json.UpdateString("macros[0].active","<boolean>");
json.UpdateString("macros[0].position","<integer>");
json.UpdateString("macros[1].id","<integer>");
json.UpdateString("macros[1].active","<boolean>");
json.UpdateString("macros[1].position","<integer>");

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/update_many",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)

// {
//   "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

string title;
string active;
string created_at;
string default;
string description;
string id;
string position;
bool Proidentf9;
string updated_at;
string url;
string app_installation;
string categories;
string permissions;
string usage_1h;
string usage_7d;
string usage_24h;
string usage_30d;
bool Deserunt_;
int Exercitation2;
string Eiusmodeaf;
string Estf5;
int Minim24;
int j;
int count_j;
string field;
string value;

string count = jResp.StringOf("count");
string next_page = jResp.StringOf("next_page");
string previous_page = jResp.StringOf("previous_page");
int i = 0;
int count_i = jResp.SizeOfArray("macros");
while (i < count_i) {
    jResp.I = i;
    title = jResp.StringOf("macros[i].title");
    active = jResp.StringOf("macros[i].active");
    created_at = jResp.StringOf("macros[i].created_at");
    default = jResp.StringOf("macros[i].default");
    description = jResp.StringOf("macros[i].description");
    id = jResp.StringOf("macros[i].id");
    position = jResp.StringOf("macros[i].position");
    Proidentf9 = jResp.BoolOf("macros[i].restriction.proidentf9");
    updated_at = jResp.StringOf("macros[i].updated_at");
    url = jResp.StringOf("macros[i].url");
    app_installation = jResp.StringOf("macros[i].app_installation");
    categories = jResp.StringOf("macros[i].categories");
    permissions = jResp.StringOf("macros[i].permissions");
    usage_1h = jResp.StringOf("macros[i].usage_1h");
    usage_7d = jResp.StringOf("macros[i].usage_7d");
    usage_24h = jResp.StringOf("macros[i].usage_24h");
    usage_30d = jResp.StringOf("macros[i].usage_30d");
    Deserunt_ = jResp.BoolOf("macros[i].restriction.deserunt_");
    Exercitation2 = jResp.IntOf("macros[i].restriction.exercitation2");
    Eiusmodeaf = jResp.StringOf("macros[i].restriction.eiusmodeaf");
    Estf5 = jResp.StringOf("macros[i].restriction.estf5");
    Minim24 = jResp.IntOf("macros[i].restriction.minim24");
    j = 0;
    count_j = jResp.SizeOfArray("macros[i].actions");
    while (j < count_j) {
        jResp.J = j;
        field = jResp.StringOf("macros[i].actions[j].field");
        value = jResp.StringOf("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}"
    }
  ]
}

Chilkat Online Tools

.NET Core C# / Support API / Update Many Macros

Curl Command

Postman Collection Item JSON