Chilkat Online Tools

Python / Support API / Update Custom Ticket Status

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

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

json = chilkat2.JsonObject()
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>")

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

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://example.zendesk.com/api/v2/custom_statuses/:custom_status_id",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.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 PUT
	-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>"
  }
}'
https://example.zendesk.com/api/v2/custom_statuses/:custom_status_id

Postman Collection Item JSON

{
  "name": "Update Custom Ticket Status",
  "request": {
    "method": "PUT",
    "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  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_statuses/:custom_status_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_statuses",
        ":custom_status_id"
      ],
      "variable": [
        {
          "key": "custom_status_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Takes a `custom_status` object that specifies the properties to update.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Updated",
      "originalRequest": {
        "method": "PUT",
        "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  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_statuses/:custom_status_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_statuses",
            ":custom_status_id"
          ],
          "variable": [
            {
              "key": "custom_status_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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}"
    }
  ]
}