Chilkat Online Tools

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.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"
;   }
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("custom_status.active","<boolean>")
$oJson.UpdateString("custom_status.agent_label","<string>")
$oJson.UpdateString("custom_status.description","<string>")
$oJson.UpdateString("custom_status.end_user_description","<string>")
$oJson.UpdateString("custom_status.end_user_label","<string>")
$oJson.UpdateString("custom_status.status_category","new")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.PostJson3("https://example.zendesk.com/api/v2/custom_statuses","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sStatus_category = $oJResp.StringOf("custom_status.status_category")
Local $sAgent_label = $oJResp.StringOf("custom_status.agent_label")
Local $sActive = $oJResp.StringOf("custom_status.active")
Local $sCreated_at = $oJResp.StringOf("custom_status.created_at")
Local $sDefault = $oJResp.StringOf("custom_status.default")
Local $sDescription = $oJResp.StringOf("custom_status.description")
Local $sEnd_user_description = $oJResp.StringOf("custom_status.end_user_description")
Local $sEnd_user_label = $oJResp.StringOf("custom_status.end_user_label")
Local $sId = $oJResp.StringOf("custom_status.id")
Local $sRaw_agent_label = $oJResp.StringOf("custom_status.raw_agent_label")
Local $sRaw_description = $oJResp.StringOf("custom_status.raw_description")
Local $sRaw_end_user_description = $oJResp.StringOf("custom_status.raw_end_user_description")
Local $sRaw_end_user_label = $oJResp.StringOf("custom_status.raw_end_user_label")
Local $sUpdated_at = $oJResp.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}"
    }
  ]
}