Chilkat Online Tools

Java / Support API / Create Brand

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // 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.

    // {
    //   "brand": {
    //     "name": "<string>",
    //     "subdomain": "<string>",
    //     "active": "<boolean>",
    //     "brand_url": "<string>",
    //     "created_at": "<dateTime>",
    //     "default": "<boolean>",
    //     "has_help_center": "<boolean>",
    //     "help_center_state": "enabled",
    //     "host_mapping": "<string>",
    //     "id": "<integer>",
    //     "is_deleted": "<boolean>",
    //     "logo": {
    //       "content_type": "<string>",
    //       "content_url": "<string>",
    //       "deleted": "<boolean>",
    //       "file_name": "<string>",
    //       "height": "<string>",
    //       "id": "<integer>",
    //       "inline": "<boolean>",
    //       "malware_access_override": "<boolean>",
    //       "malware_scan_result": "<string>",
    //       "mapped_content_url": "<string>",
    //       "size": "<integer>",
    //       "url": "<string>",
    //       "width": "<string>",
    //       "thumbnails": [
    //         {
    //           "content_type": "<string>",
    //           "content_url": "<string>",
    //           "deleted": "<boolean>",
    //           "file_name": "<string>",
    //           "height": "<string>",
    //           "id": "<integer>",
    //           "inline": "<boolean>",
    //           "malware_access_override": "<boolean>",
    //           "malware_scan_result": "<string>",
    //           "mapped_content_url": "<string>",
    //           "size": "<integer>",
    //           "url": "<string>",
    //           "width": "<string>"
    //         },
    //         {
    //           "content_type": "<string>",
    //           "content_url": "<string>",
    //           "deleted": "<boolean>",
    //           "file_name": "<string>",
    //           "height": "<string>",
    //           "id": "<integer>",
    //           "inline": "<boolean>",
    //           "malware_access_override": "<boolean>",
    //           "malware_scan_result": "<string>",
    //           "mapped_content_url": "<string>",
    //           "size": "<integer>",
    //           "url": "<string>",
    //           "width": "<string>"
    //         }
    //       ]
    //     },
    //     "signature_template": "<string>",
    //     "ticket_form_ids": "<array>",
    //     "updated_at": "<dateTime>",
    //     "url": "<string>"
    //   }
    // }

    CkJsonObject json = new CkJsonObject();
    json.UpdateString("brand.name","<string>");
    json.UpdateString("brand.subdomain","<string>");
    json.UpdateString("brand.active","<boolean>");
    json.UpdateString("brand.brand_url","<string>");
    json.UpdateString("brand.created_at","<dateTime>");
    json.UpdateString("brand.default","<boolean>");
    json.UpdateString("brand.has_help_center","<boolean>");
    json.UpdateString("brand.help_center_state","enabled");
    json.UpdateString("brand.host_mapping","<string>");
    json.UpdateString("brand.id","<integer>");
    json.UpdateString("brand.is_deleted","<boolean>");
    json.UpdateString("brand.logo.content_type","<string>");
    json.UpdateString("brand.logo.content_url","<string>");
    json.UpdateString("brand.logo.deleted","<boolean>");
    json.UpdateString("brand.logo.file_name","<string>");
    json.UpdateString("brand.logo.height","<string>");
    json.UpdateString("brand.logo.id","<integer>");
    json.UpdateString("brand.logo.inline","<boolean>");
    json.UpdateString("brand.logo.malware_access_override","<boolean>");
    json.UpdateString("brand.logo.malware_scan_result","<string>");
    json.UpdateString("brand.logo.mapped_content_url","<string>");
    json.UpdateString("brand.logo.size","<integer>");
    json.UpdateString("brand.logo.url","<string>");
    json.UpdateString("brand.logo.width","<string>");
    json.UpdateString("brand.logo.thumbnails[0].content_type","<string>");
    json.UpdateString("brand.logo.thumbnails[0].content_url","<string>");
    json.UpdateString("brand.logo.thumbnails[0].deleted","<boolean>");
    json.UpdateString("brand.logo.thumbnails[0].file_name","<string>");
    json.UpdateString("brand.logo.thumbnails[0].height","<string>");
    json.UpdateString("brand.logo.thumbnails[0].id","<integer>");
    json.UpdateString("brand.logo.thumbnails[0].inline","<boolean>");
    json.UpdateString("brand.logo.thumbnails[0].malware_access_override","<boolean>");
    json.UpdateString("brand.logo.thumbnails[0].malware_scan_result","<string>");
    json.UpdateString("brand.logo.thumbnails[0].mapped_content_url","<string>");
    json.UpdateString("brand.logo.thumbnails[0].size","<integer>");
    json.UpdateString("brand.logo.thumbnails[0].url","<string>");
    json.UpdateString("brand.logo.thumbnails[0].width","<string>");
    json.UpdateString("brand.logo.thumbnails[1].content_type","<string>");
    json.UpdateString("brand.logo.thumbnails[1].content_url","<string>");
    json.UpdateString("brand.logo.thumbnails[1].deleted","<boolean>");
    json.UpdateString("brand.logo.thumbnails[1].file_name","<string>");
    json.UpdateString("brand.logo.thumbnails[1].height","<string>");
    json.UpdateString("brand.logo.thumbnails[1].id","<integer>");
    json.UpdateString("brand.logo.thumbnails[1].inline","<boolean>");
    json.UpdateString("brand.logo.thumbnails[1].malware_access_override","<boolean>");
    json.UpdateString("brand.logo.thumbnails[1].malware_scan_result","<string>");
    json.UpdateString("brand.logo.thumbnails[1].mapped_content_url","<string>");
    json.UpdateString("brand.logo.thumbnails[1].size","<integer>");
    json.UpdateString("brand.logo.thumbnails[1].url","<string>");
    json.UpdateString("brand.logo.thumbnails[1].width","<string>");
    json.UpdateString("brand.signature_template","<string>");
    json.UpdateString("brand.ticket_form_ids","<array>");
    json.UpdateString("brand.updated_at","<dateTime>");
    json.UpdateString("brand.url","<string>");

    http.SetRequestHeader("Content-Type","application/json");
    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse resp = http.PostJson3("https://example.zendesk.com/api/v2/brands","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

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

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

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "brand": {
    //     "name": "<string>",
    //     "subdomain": "<string>",
    //     "active": "<boolean>",
    //     "brand_url": "<string>",
    //     "created_at": "<dateTime>",
    //     "default": "<boolean>",
    //     "has_help_center": "<boolean>",
    //     "help_center_state": "enabled",
    //     "host_mapping": "<string>",
    //     "id": "<integer>",
    //     "is_deleted": "<boolean>",
    //     "logo": {
    //       "content_type": "<string>",
    //       "content_url": "<string>",
    //       "deleted": "<boolean>",
    //       "file_name": "<string>",
    //       "height": "<string>",
    //       "id": "<integer>",
    //       "inline": "<boolean>",
    //       "malware_access_override": "<boolean>",
    //       "malware_scan_result": "<string>",
    //       "mapped_content_url": "<string>",
    //       "size": "<integer>",
    //       "url": "<string>",
    //       "width": "<string>",
    //       "thumbnails": [
    //         {
    //           "content_type": "<string>",
    //           "content_url": "<string>",
    //           "deleted": "<boolean>",
    //           "file_name": "<string>",
    //           "height": "<string>",
    //           "id": "<integer>",
    //           "inline": "<boolean>",
    //           "malware_access_override": "<boolean>",
    //           "malware_scan_result": "<string>",
    //           "mapped_content_url": "<string>",
    //           "size": "<integer>",
    //           "url": "<string>",
    //           "width": "<string>"
    //         },
    //         {
    //           "content_type": "<string>",
    //           "content_url": "<string>",
    //           "deleted": "<boolean>",
    //           "file_name": "<string>",
    //           "height": "<string>",
    //           "id": "<integer>",
    //           "inline": "<boolean>",
    //           "malware_access_override": "<boolean>",
    //           "malware_scan_result": "<string>",
    //           "mapped_content_url": "<string>",
    //           "size": "<integer>",
    //           "url": "<string>",
    //           "width": "<string>"
    //         }
    //       ]
    //     },
    //     "signature_template": "<string>",
    //     "ticket_form_ids": "<array>",
    //     "updated_at": "<dateTime>",
    //     "url": "<string>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    String content_type;
    String content_url;
    String deleted;
    String file_name;
    String height;
    String id;
    String inline;
    String malware_access_override;
    String malware_scan_result;
    String mapped_content_url;
    String size;
    String url;
    String width;

    String Name = jResp.stringOf("brand.name");
    String Subdomain = jResp.stringOf("brand.subdomain");
    String Active = jResp.stringOf("brand.active");
    String Brand_url = jResp.stringOf("brand.brand_url");
    String Created_at = jResp.stringOf("brand.created_at");
    String Default = jResp.stringOf("brand.default");
    String Has_help_center = jResp.stringOf("brand.has_help_center");
    String Help_center_state = jResp.stringOf("brand.help_center_state");
    String Host_mapping = jResp.stringOf("brand.host_mapping");
    String Id = jResp.stringOf("brand.id");
    String Is_deleted = jResp.stringOf("brand.is_deleted");
    String Content_type = jResp.stringOf("brand.logo.content_type");
    String Content_url = jResp.stringOf("brand.logo.content_url");
    String Deleted = jResp.stringOf("brand.logo.deleted");
    String File_name = jResp.stringOf("brand.logo.file_name");
    String Height = jResp.stringOf("brand.logo.height");
    String LogoId = jResp.stringOf("brand.logo.id");
    String Inline = jResp.stringOf("brand.logo.inline");
    String Malware_access_override = jResp.stringOf("brand.logo.malware_access_override");
    String Malware_scan_result = jResp.stringOf("brand.logo.malware_scan_result");
    String Mapped_content_url = jResp.stringOf("brand.logo.mapped_content_url");
    String Size = jResp.stringOf("brand.logo.size");
    String v_Url = jResp.stringOf("brand.logo.url");
    String Width = jResp.stringOf("brand.logo.width");
    String Signature_template = jResp.stringOf("brand.signature_template");
    String Ticket_form_ids = jResp.stringOf("brand.ticket_form_ids");
    String Updated_at = jResp.stringOf("brand.updated_at");
    String brandUrl = jResp.stringOf("brand.url");
    int i = 0;
    int count_i = jResp.SizeOfArray("brand.logo.thumbnails");
    while (i < count_i) {
        jResp.put_I(i);
        content_type = jResp.stringOf("brand.logo.thumbnails[i].content_type");
        content_url = jResp.stringOf("brand.logo.thumbnails[i].content_url");
        deleted = jResp.stringOf("brand.logo.thumbnails[i].deleted");
        file_name = jResp.stringOf("brand.logo.thumbnails[i].file_name");
        height = jResp.stringOf("brand.logo.thumbnails[i].height");
        id = jResp.stringOf("brand.logo.thumbnails[i].id");
        inline = jResp.stringOf("brand.logo.thumbnails[i].inline");
        malware_access_override = jResp.stringOf("brand.logo.thumbnails[i].malware_access_override");
        malware_scan_result = jResp.stringOf("brand.logo.thumbnails[i].malware_scan_result");
        mapped_content_url = jResp.stringOf("brand.logo.thumbnails[i].mapped_content_url");
        size = jResp.stringOf("brand.logo.thumbnails[i].size");
        url = jResp.stringOf("brand.logo.thumbnails[i].url");
        width = jResp.stringOf("brand.logo.thumbnails[i].width");
        i = i+1;
        }
  }
}

Curl Command

curl  -u login:password -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "brand": {
    "name": "<string>",
    "subdomain": "<string>",
    "active": "<boolean>",
    "brand_url": "<string>",
    "created_at": "<dateTime>",
    "default": "<boolean>",
    "has_help_center": "<boolean>",
    "help_center_state": "enabled",
    "host_mapping": "<string>",
    "id": "<integer>",
    "is_deleted": "<boolean>",
    "logo": {
      "content_type": "<string>",
      "content_url": "<string>",
      "deleted": "<boolean>",
      "file_name": "<string>",
      "height": "<string>",
      "id": "<integer>",
      "inline": "<boolean>",
      "malware_access_override": "<boolean>",
      "malware_scan_result": "<string>",
      "mapped_content_url": "<string>",
      "size": "<integer>",
      "url": "<string>",
      "width": "<string>",
      "thumbnails": [
        {
          "content_type": "<string>",
          "content_url": "<string>",
          "deleted": "<boolean>",
          "file_name": "<string>",
          "height": "<string>",
          "id": "<integer>",
          "inline": "<boolean>",
          "malware_access_override": "<boolean>",
          "malware_scan_result": "<string>",
          "mapped_content_url": "<string>",
          "size": "<integer>",
          "url": "<string>",
          "width": "<string>"
        },
        {
          "content_type": "<string>",
          "content_url": "<string>",
          "deleted": "<boolean>",
          "file_name": "<string>",
          "height": "<string>",
          "id": "<integer>",
          "inline": "<boolean>",
          "malware_access_override": "<boolean>",
          "malware_scan_result": "<string>",
          "mapped_content_url": "<string>",
          "size": "<integer>",
          "url": "<string>",
          "width": "<string>"
        }
      ]
    },
    "signature_template": "<string>",
    "ticket_form_ids": "<array>",
    "updated_at": "<dateTime>",
    "url": "<string>"
  }
}'
https://example.zendesk.com/api/v2/brands

Postman Collection Item JSON

{
  "name": "Create Brand",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"subdomain\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"brand_url\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"has_help_center\": \"<boolean>\",\n    \"help_center_state\": \"enabled\",\n    \"host_mapping\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"is_deleted\": \"<boolean>\",\n    \"logo\": {\n      \"content_type\": \"<string>\",\n      \"content_url\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"file_name\": \"<string>\",\n      \"height\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"inline\": \"<boolean>\",\n      \"malware_access_override\": \"<boolean>\",\n      \"malware_scan_result\": \"<string>\",\n      \"mapped_content_url\": \"<string>\",\n      \"size\": \"<integer>\",\n      \"url\": \"<string>\",\n      \"width\": \"<string>\",\n      \"thumbnails\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        }\n      ]\n    },\n    \"signature_template\": \"<string>\",\n    \"ticket_form_ids\": \"<array>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/brands",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "brands"
      ]
    },
    "description": "#### Allowed for\n- Admins"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "POST",
        "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  \"brand\": {\n    \"name\": \"<string>\",\n    \"subdomain\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"brand_url\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"has_help_center\": \"<boolean>\",\n    \"help_center_state\": \"enabled\",\n    \"host_mapping\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"is_deleted\": \"<boolean>\",\n    \"logo\": {\n      \"content_type\": \"<string>\",\n      \"content_url\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"file_name\": \"<string>\",\n      \"height\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"inline\": \"<boolean>\",\n      \"malware_access_override\": \"<boolean>\",\n      \"malware_scan_result\": \"<string>\",\n      \"mapped_content_url\": \"<string>\",\n      \"size\": \"<integer>\",\n      \"url\": \"<string>\",\n      \"width\": \"<string>\",\n      \"thumbnails\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        }\n      ]\n    },\n    \"signature_template\": \"<string>\",\n    \"ticket_form_ids\": \"<array>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/brands",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "brands"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"subdomain\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"brand_url\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"has_help_center\": \"<boolean>\",\n    \"help_center_state\": \"enabled\",\n    \"host_mapping\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"is_deleted\": \"<boolean>\",\n    \"logo\": {\n      \"content_type\": \"<string>\",\n      \"content_url\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"file_name\": \"<string>\",\n      \"height\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"inline\": \"<boolean>\",\n      \"malware_access_override\": \"<boolean>\",\n      \"malware_scan_result\": \"<string>\",\n      \"mapped_content_url\": \"<string>\",\n      \"size\": \"<integer>\",\n      \"url\": \"<string>\",\n      \"width\": \"<string>\",\n      \"thumbnails\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        }\n      ]\n    },\n    \"signature_template\": \"<string>\",\n    \"ticket_form_ids\": \"<array>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}