Chilkat Online Tools

Xojo / Support API / Create Custom Ticket Status

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim json As New Chilkat.JsonObject
success = json.UpdateString("custom_status.active","<boolean>")
success = json.UpdateString("custom_status.agent_label","<string>")
success = json.UpdateString("custom_status.description","<string>")
success = json.UpdateString("custom_status.end_user_description","<string>")
success = json.UpdateString("custom_status.end_user_label","<string>")
success = json.UpdateString("custom_status.status_category","new")

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

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://example.zendesk.com/api/v2/custom_statuses","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

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

Dim Status_category As String
Status_category = jResp.StringOf("custom_status.status_category")
Dim Agent_label As String
Agent_label = jResp.StringOf("custom_status.agent_label")
Dim Active As String
Active = jResp.StringOf("custom_status.active")
Dim Created_at As String
Created_at = jResp.StringOf("custom_status.created_at")
Dim Default As String
Default = jResp.StringOf("custom_status.default")
Dim Description As String
Description = jResp.StringOf("custom_status.description")
Dim End_user_description As String
End_user_description = jResp.StringOf("custom_status.end_user_description")
Dim End_user_label As String
End_user_label = jResp.StringOf("custom_status.end_user_label")
Dim Id As String
Id = jResp.StringOf("custom_status.id")
Dim Raw_agent_label As String
Raw_agent_label = jResp.StringOf("custom_status.raw_agent_label")
Dim Raw_description As String
Raw_description = jResp.StringOf("custom_status.raw_description")
Dim Raw_end_user_description As String
Raw_end_user_description = jResp.StringOf("custom_status.raw_end_user_description")
Dim Raw_end_user_label As String
Raw_end_user_label = jResp.StringOf("custom_status.raw_end_user_label")
Dim Updated_at As String
Updated_at = jResp.StringOf("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}"
    }
  ]
}