delphiDll / Support API / Update Custom Ticket Status
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Status_category: PWideChar;
Agent_label: PWideChar;
Active: PWideChar;
Created_at: PWideChar;
Default: PWideChar;
Description: PWideChar;
End_user_description: PWideChar;
End_user_label: PWideChar;
Id: PWideChar;
Raw_agent_label: PWideChar;
Raw_description: PWideChar;
Raw_end_user_description: PWideChar;
Raw_end_user_label: PWideChar;
Updated_at: PWideChar;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(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>"
// }
// }
json := CkJsonObject_Create();
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>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'Accept','application/json');
sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp := CkHttp_PTextSb(http,'PUT','https://example.zendesk.com/api/v2/custom_statuses/:custom_status_id',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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
Status_category := CkJsonObject__stringOf(jResp,'custom_status.status_category');
Agent_label := CkJsonObject__stringOf(jResp,'custom_status.agent_label');
Active := CkJsonObject__stringOf(jResp,'custom_status.active');
Created_at := CkJsonObject__stringOf(jResp,'custom_status.created_at');
Default := CkJsonObject__stringOf(jResp,'custom_status.default');
Description := CkJsonObject__stringOf(jResp,'custom_status.description');
End_user_description := CkJsonObject__stringOf(jResp,'custom_status.end_user_description');
End_user_label := CkJsonObject__stringOf(jResp,'custom_status.end_user_label');
Id := CkJsonObject__stringOf(jResp,'custom_status.id');
Raw_agent_label := CkJsonObject__stringOf(jResp,'custom_status.raw_agent_label');
Raw_description := CkJsonObject__stringOf(jResp,'custom_status.raw_description');
Raw_end_user_description := CkJsonObject__stringOf(jResp,'custom_status.raw_end_user_description');
Raw_end_user_label := CkJsonObject__stringOf(jResp,'custom_status.raw_end_user_label');
Updated_at := CkJsonObject__stringOf(jResp,'custom_status.updated_at');
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
