Chilkat Online Tools

C++ / Support API / Update Macro

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_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
    //     }
    //   }
    // }

    CkJsonObject json;
    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");

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PUT","https://example.zendesk.com/api/v2/macros/:macro_id",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *field = 0;
    const char *value = 0;

    const char *Title = jResp.stringOf("macro.title");
    const char *Active = jResp.stringOf("macro.active");
    const char *Created_at = jResp.stringOf("macro.created_at");
    const char *Default = jResp.stringOf("macro.default");
    const char *Description = jResp.stringOf("macro.description");
    const char *Id = jResp.stringOf("macro.id");
    const char *Position = jResp.stringOf("macro.position");
    const char *Utc = jResp.stringOf("macro.restriction.utc");
    const char *Sint_c = jResp.stringOf("macro.restriction.sint_c");
    const char *Updated_at = jResp.stringOf("macro.updated_at");
    const char *v_Url = jResp.stringOf("macro.url");
    const char *App_installation = jResp.stringOf("macro.app_installation");
    const char *Categories = jResp.stringOf("macro.categories");
    const char *Permissions = jResp.stringOf("macro.permissions");
    const char *Usage_1h = jResp.stringOf("macro.usage_1h");
    const char *Usage_7d = jResp.stringOf("macro.usage_7d");
    const char *Usage_24h = jResp.stringOf("macro.usage_24h");
    const char *Usage_30d = jResp.stringOf("macro.usage_30d");
    int i = 0;
    int count_i = jResp.SizeOfArray("macro.actions");
    while (i < count_i) {
        jResp.put_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}"
    }
  ]
}