TCL / Support API / Create Custom Ticket Status
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "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"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "custom_status.active" "<boolean>"
CkJsonObject_UpdateString $json "custom_status.agent_label" "<string>"
CkJsonObject_UpdateString $json "custom_status.description" "<string>"
CkJsonObject_UpdateString $json "custom_status.end_user_description" "<string>"
CkJsonObject_UpdateString $json "custom_status.end_user_label" "<string>"
CkJsonObject_UpdateString $json "custom_status.status_category" "new"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://example.zendesk.com/api/v2/custom_statuses" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Status_category [CkJsonObject_stringOf $jResp "custom_status.status_category"]
set Agent_label [CkJsonObject_stringOf $jResp "custom_status.agent_label"]
set Active [CkJsonObject_stringOf $jResp "custom_status.active"]
set Created_at [CkJsonObject_stringOf $jResp "custom_status.created_at"]
set Default [CkJsonObject_stringOf $jResp "custom_status.default"]
set Description [CkJsonObject_stringOf $jResp "custom_status.description"]
set End_user_description [CkJsonObject_stringOf $jResp "custom_status.end_user_description"]
set End_user_label [CkJsonObject_stringOf $jResp "custom_status.end_user_label"]
set Id [CkJsonObject_stringOf $jResp "custom_status.id"]
set Raw_agent_label [CkJsonObject_stringOf $jResp "custom_status.raw_agent_label"]
set Raw_description [CkJsonObject_stringOf $jResp "custom_status.raw_description"]
set Raw_end_user_description [CkJsonObject_stringOf $jResp "custom_status.raw_end_user_description"]
set Raw_end_user_label [CkJsonObject_stringOf $jResp "custom_status.raw_end_user_label"]
set Updated_at [CkJsonObject_stringOf $jResp "custom_status.updated_at"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}