Chilkat Online Tools

Swift3 / Support API / Create Custom Ticket Status

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    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.

    // {
    //   "custom_status": {
    //     "active": "<boolean>",
    //     "agent_label": "<string>",
    //     "description": "<string>",
    //     "end_user_description": "<string>",
    //     "end_user_label": "<string>",
    //     "status_category": "new"
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("custom_status.active", value: "<boolean>")
    json.update("custom_status.agent_label", value: "<string>")
    json.update("custom_status.description", value: "<string>")
    json.update("custom_status.end_user_description", value: "<string>")
    json.update("custom_status.end_user_label", value: "<string>")
    json.update("custom_status.status_category", value: "new")

    http.setRequestHeader("Content-Type", value: "application/json")
    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.postJson3("https://example.zendesk.com/api/v2/custom_statuses", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "custom_status": {
    //     "status_category": "open",
    //     "agent_label": "<string>",
    //     "active": "<boolean>",
    //     "created_at": "<dateTime>",
    //     "default": "<boolean>",
    //     "description": "<string>",
    //     "end_user_description": "<string>",
    //     "end_user_label": "<string>",
    //     "id": "<integer>",
    //     "raw_agent_label": "<string>",
    //     "raw_description": "<string>",
    //     "raw_end_user_description": "<string>",
    //     "raw_end_user_label": "<string>",
    //     "updated_at": "<dateTime>"
    //   }
    // }

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

    var Status_category: String? = jResp.string(of: "custom_status.status_category")
    var Agent_label: String? = jResp.string(of: "custom_status.agent_label")
    var Active: String? = jResp.string(of: "custom_status.active")
    var Created_at: String? = jResp.string(of: "custom_status.created_at")
    var Default: String? = jResp.string(of: "custom_status.default")
    var Description: String? = jResp.string(of: "custom_status.description")
    var End_user_description: String? = jResp.string(of: "custom_status.end_user_description")
    var End_user_label: String? = jResp.string(of: "custom_status.end_user_label")
    var Id: String? = jResp.string(of: "custom_status.id")
    var Raw_agent_label: String? = jResp.string(of: "custom_status.raw_agent_label")
    var Raw_description: String? = jResp.string(of: "custom_status.raw_description")
    var Raw_end_user_description: String? = jResp.string(of: "custom_status.raw_end_user_description")
    var Raw_end_user_label: String? = jResp.string(of: "custom_status.raw_end_user_label")
    var Updated_at: String? = jResp.string(of: "custom_status.updated_at")

}

Curl Command

curl  -u login:password -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "custom_status": {
    "active": "<boolean>",
    "agent_label": "<string>",
    "description": "<string>",
    "end_user_description": "<string>",
    "end_user_label": "<string>",
    "status_category": "new"
  }
}'
https://example.zendesk.com/api/v2/custom_statuses

Postman Collection Item JSON

{
  "name": "Create Custom Ticket Status",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"custom_status\": {\n    \"active\": \"<boolean>\",\n    \"agent_label\": \"<string>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"status_category\": \"new\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_statuses",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_statuses"
      ]
    },
    "description": "Takes a `custom_status` object that specifies the custom ticket status properties to create.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Created",
      "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  \"custom_status\": {\n    \"active\": \"<boolean>\",\n    \"agent_label\": \"<string>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"status_category\": \"new\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_statuses",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_statuses"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_status\": {\n    \"status_category\": \"open\",\n    \"agent_label\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"raw_agent_label\": \"<string>\",\n    \"raw_description\": \"<string>\",\n    \"raw_end_user_description\": \"<string>\",\n    \"raw_end_user_label\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}