Python / Support API / Create Custom Ticket Status
Back to Collection Items
import sys
import chilkat
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat.CkHttp()
http.put_BasicAuth(True)
http.put_Login("login")
http.put_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"
# }
# }
json = chilkat.CkJsonObject()
json.UpdateString("custom_status.active","<boolean>")
json.UpdateString("custom_status.agent_label","<string>")
json.UpdateString("custom_status.description","<string>")
json.UpdateString("custom_status.end_user_description","<string>")
json.UpdateString("custom_status.end_user_label","<string>")
json.UpdateString("custom_status.status_category","new")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://example.zendesk.com/api/v2/custom_statuses","application/json",json)
if (http.get_LastMethodSuccess() == False):
print(http.lastErrorText())
sys.exit()
sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)
print("Response Body:")
print(jResp.emit())
respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.header())
print("Failed.")
sys.exit()
# 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
Status_category = jResp.stringOf("custom_status.status_category")
Agent_label = jResp.stringOf("custom_status.agent_label")
Active = jResp.stringOf("custom_status.active")
Created_at = jResp.stringOf("custom_status.created_at")
Default = jResp.stringOf("custom_status.default")
Description = jResp.stringOf("custom_status.description")
End_user_description = jResp.stringOf("custom_status.end_user_description")
End_user_label = jResp.stringOf("custom_status.end_user_label")
Id = jResp.stringOf("custom_status.id")
Raw_agent_label = jResp.stringOf("custom_status.raw_agent_label")
Raw_description = jResp.stringOf("custom_status.raw_description")
Raw_end_user_description = jResp.stringOf("custom_status.raw_end_user_description")
Raw_end_user_label = jResp.stringOf("custom_status.raw_end_user_label")
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}"
}
]
}