Chilkat Online Tools

Android / Support API / Update Many Macros

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean 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.

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

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

    CkStringBuilder sbRequestBody = new CkStringBuilder();
    json.EmitSb(sbRequestBody);

    CkHttpResponse resp = http.PTextSb("PUT","https://example.zendesk.com/api/v2/macros/update_many",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

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

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "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;
    boolean 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;
    boolean 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.put_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.put_J(j);
            field = jResp.stringOf("macros[i].actions[j].field");
            value = jResp.stringOf("macros[i].actions[j].value");
            j = j + 1;
            }

        i = i + 1;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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}"
    }
  ]
}