Chilkat Online Tools

unicodeCpp / Support API / Create Ticket Field

Back to Collection Items

#include <CkHttpW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

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

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"login");
    http.put_Password(L"password");

    http.SetRequestHeader(L"Accept",L"application/json");

    CkHttpResponseW *resp = http.QuickRequest(L"POST",L"https://example.zendesk.com/api/v2/ticket_fields");
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

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

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "ticket_field": {
    //     "type": "<string>",
    //     "title": "<string>",
    //     "active": "<boolean>",
    //     "agent_description": "<string>",
    //     "collapsed_for_agents": "<boolean>",
    //     "created_at": "<dateTime>",
    //     "custom_field_options": [
    //       {
    //         "name": "<string>",
    //         "value": "<string>",
    //         "id": "<integer>",
    //         "position": "<integer>",
    //         "raw_name": "<string>",
    //         "url": "<string>"
    //       },
    //       {
    //         "name": "<string>",
    //         "value": "<string>",
    //         "id": "<integer>",
    //         "position": "<integer>",
    //         "raw_name": "<string>",
    //         "url": "<string>"
    //       }
    //     ],
    //     "custom_statuses": [
    //       {
    //         "active": "<boolean>",
    //         "agent_label": "<string>",
    //         "created_at": "<dateTime>",
    //         "default": "<boolean>",
    //         "description": "<string>",
    //         "end_user_description": "<string>",
    //         "end_user_label": "<string>",
    //         "id": "<integer>",
    //         "status_category": "solved",
    //         "updated_at": "<dateTime>"
    //       },
    //       {
    //         "active": "<boolean>",
    //         "agent_label": "<string>",
    //         "created_at": "<dateTime>",
    //         "default": "<boolean>",
    //         "description": "<string>",
    //         "end_user_description": "<string>",
    //         "end_user_label": "<string>",
    //         "id": "<integer>",
    //         "status_category": "open",
    //         "updated_at": "<dateTime>"
    //       }
    //     ],
    //     "description": "<string>",
    //     "editable_in_portal": "<boolean>",
    //     "id": "<integer>",
    //     "position": "<integer>",
    //     "raw_description": "<string>",
    //     "raw_title": "<string>",
    //     "raw_title_in_portal": "<string>",
    //     "regexp_for_validation": "<string>",
    //     "relationship_filter": {},
    //     "relationship_target_type": "<string>",
    //     "removable": "<boolean>",
    //     "required": "<boolean>",
    //     "required_in_portal": "<boolean>",
    //     "sub_type_id": "<integer>",
    //     "system_field_options": [
    //       {
    //         "name": "<string>",
    //         "value": "<string>"
    //       },
    //       {
    //         "name": "<string>",
    //         "value": "<string>"
    //       }
    //     ],
    //     "tag": "<string>",
    //     "title_in_portal": "<string>",
    //     "updated_at": "<dateTime>",
    //     "url": "<string>",
    //     "visible_in_portal": "<boolean>"
    //   }
    // }

    // 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 wchar_t *name = 0;
    const wchar_t *value = 0;
    const wchar_t *id = 0;
    const wchar_t *position = 0;
    const wchar_t *raw_name = 0;
    const wchar_t *url = 0;
    const wchar_t *active = 0;
    const wchar_t *agent_label = 0;
    const wchar_t *created_at = 0;
    const wchar_t *default = 0;
    const wchar_t *description = 0;
    const wchar_t *end_user_description = 0;
    const wchar_t *end_user_label = 0;
    const wchar_t *status_category = 0;
    const wchar_t *updated_at = 0;

    const wchar_t *v_Type = jResp.stringOf(L"ticket_field.type");
    const wchar_t *Title = jResp.stringOf(L"ticket_field.title");
    const wchar_t *Active = jResp.stringOf(L"ticket_field.active");
    const wchar_t *Agent_description = jResp.stringOf(L"ticket_field.agent_description");
    const wchar_t *Collapsed_for_agents = jResp.stringOf(L"ticket_field.collapsed_for_agents");
    const wchar_t *Created_at = jResp.stringOf(L"ticket_field.created_at");
    const wchar_t *Description = jResp.stringOf(L"ticket_field.description");
    const wchar_t *Editable_in_portal = jResp.stringOf(L"ticket_field.editable_in_portal");
    const wchar_t *Id = jResp.stringOf(L"ticket_field.id");
    const wchar_t *Position = jResp.stringOf(L"ticket_field.position");
    const wchar_t *Raw_description = jResp.stringOf(L"ticket_field.raw_description");
    const wchar_t *Raw_title = jResp.stringOf(L"ticket_field.raw_title");
    const wchar_t *Raw_title_in_portal = jResp.stringOf(L"ticket_field.raw_title_in_portal");
    const wchar_t *Regexp_for_validation = jResp.stringOf(L"ticket_field.regexp_for_validation");
    const wchar_t *Relationship_target_type = jResp.stringOf(L"ticket_field.relationship_target_type");
    const wchar_t *Removable = jResp.stringOf(L"ticket_field.removable");
    const wchar_t *Required = jResp.stringOf(L"ticket_field.required");
    const wchar_t *Required_in_portal = jResp.stringOf(L"ticket_field.required_in_portal");
    const wchar_t *Sub_type_id = jResp.stringOf(L"ticket_field.sub_type_id");
    const wchar_t *Tag = jResp.stringOf(L"ticket_field.tag");
    const wchar_t *Title_in_portal = jResp.stringOf(L"ticket_field.title_in_portal");
    const wchar_t *Updated_at = jResp.stringOf(L"ticket_field.updated_at");
    const wchar_t *v_Url = jResp.stringOf(L"ticket_field.url");
    const wchar_t *Visible_in_portal = jResp.stringOf(L"ticket_field.visible_in_portal");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"ticket_field.custom_field_options");
    while (i < count_i) {
        jResp.put_I(i);
        name = jResp.stringOf(L"ticket_field.custom_field_options[i].name");
        value = jResp.stringOf(L"ticket_field.custom_field_options[i].value");
        id = jResp.stringOf(L"ticket_field.custom_field_options[i].id");
        position = jResp.stringOf(L"ticket_field.custom_field_options[i].position");
        raw_name = jResp.stringOf(L"ticket_field.custom_field_options[i].raw_name");
        url = jResp.stringOf(L"ticket_field.custom_field_options[i].url");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"ticket_field.custom_statuses");
    while (i < count_i) {
        jResp.put_I(i);
        active = jResp.stringOf(L"ticket_field.custom_statuses[i].active");
        agent_label = jResp.stringOf(L"ticket_field.custom_statuses[i].agent_label");
        created_at = jResp.stringOf(L"ticket_field.custom_statuses[i].created_at");
        default = jResp.stringOf(L"ticket_field.custom_statuses[i].default");
        description = jResp.stringOf(L"ticket_field.custom_statuses[i].description");
        end_user_description = jResp.stringOf(L"ticket_field.custom_statuses[i].end_user_description");
        end_user_label = jResp.stringOf(L"ticket_field.custom_statuses[i].end_user_label");
        id = jResp.stringOf(L"ticket_field.custom_statuses[i].id");
        status_category = jResp.stringOf(L"ticket_field.custom_statuses[i].status_category");
        updated_at = jResp.stringOf(L"ticket_field.custom_statuses[i].updated_at");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"ticket_field.system_field_options");
    while (i < count_i) {
        jResp.put_I(i);
        name = jResp.stringOf(L"ticket_field.system_field_options[i].name");
        value = jResp.stringOf(L"ticket_field.system_field_options[i].value");
        i = i + 1;
    }
    }

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_fields

Postman Collection Item JSON

{
  "name": "Create Ticket Field",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_fields"
      ]
    },
    "description": "Creates any of the following custom field types:\n\n| Custom field type | Description                                                                                                                                                     |\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| text              | Default custom field type when `type` is not specified                                                                                                          |\n| textarea          | For multi-line text                                                                                                                                             |\n| checkbox          | To capture a boolean value. Allowed values are true or false                                                                                                    |\n| date              | Example: 2021-04-16                                                                                                                                   |\n| integer           | String composed of numbers. May contain an optional decimal point                                                                                               |\n| decimal           | For numbers containing decimals                                                                                                                                 |\n| regexp            | Matches the Regex pattern found in the custom field settings                                                                                                    |\n| partialcreditcard | A credit card number. Only the last 4 digits are retained                                                                                                                                      |\n| multiselect       | Enables users to choose multiple options from a dropdown menu                                                                                                |\n| tagger            | Single-select dropdown menu. It contains one or more tag values belonging to the field's options. Example: ( {\"id\": 21938362, \"value\": [\"hd_3000\", \"hd_5555\"]}) |\n| lookup            | A field to create a relationship (see [lookup relationships](/api-reference/ticketing/lookup_relationships/lookup_relationships/)) to another object such as a user, ticket, or organization |\n\nSee [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in the Zendesk Help Center.\n\n#### Allowed For\n\n* Admins\n\n#### Field limits\n\nWe recommend the following best practices for ticket fields limits. Creating more than these amounts can affect performance.\n\n* 400 ticket fields per account if your account doesn't have ticket forms\n* 400 ticket fields per ticket form if your account has ticket forms\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/ticket_fields",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_fields"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ticket_field\": {\n    \"type\": \"<string>\",\n    \"title\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"agent_description\": \"<string>\",\n    \"collapsed_for_agents\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"custom_field_options\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"custom_statuses\": [\n      {\n        \"active\": \"<boolean>\",\n        \"agent_label\": \"<string>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"end_user_description\": \"<string>\",\n        \"end_user_label\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"status_category\": \"solved\",\n        \"updated_at\": \"<dateTime>\"\n      },\n      {\n        \"active\": \"<boolean>\",\n        \"agent_label\": \"<string>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"end_user_description\": \"<string>\",\n        \"end_user_label\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"status_category\": \"open\",\n        \"updated_at\": \"<dateTime>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"editable_in_portal\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_description\": \"<string>\",\n    \"raw_title\": \"<string>\",\n    \"raw_title_in_portal\": \"<string>\",\n    \"regexp_for_validation\": \"<string>\",\n    \"relationship_filter\": {},\n    \"relationship_target_type\": \"<string>\",\n    \"removable\": \"<boolean>\",\n    \"required\": \"<boolean>\",\n    \"required_in_portal\": \"<boolean>\",\n    \"sub_type_id\": \"<integer>\",\n    \"system_field_options\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"tag\": \"<string>\",\n    \"title_in_portal\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\",\n    \"visible_in_portal\": \"<boolean>\"\n  }\n}"
    }
  ]
}