unicodeC / Support API / Create Custom Ticket Status
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Status_category;
const wchar_t *Agent_label;
const wchar_t *Active;
const wchar_t *Created_at;
const wchar_t *Default;
const wchar_t *Description;
const wchar_t *End_user_description;
const wchar_t *End_user_label;
const wchar_t *Id;
const wchar_t *Raw_agent_label;
const wchar_t *Raw_description;
const wchar_t *Raw_end_user_description;
const wchar_t *Raw_end_user_label;
const wchar_t *Updated_at;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"login");
CkHttpW_putPassword(http,L"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 = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"custom_status.active",L"<boolean>");
CkJsonObjectW_UpdateString(json,L"custom_status.agent_label",L"<string>");
CkJsonObjectW_UpdateString(json,L"custom_status.description",L"<string>");
CkJsonObjectW_UpdateString(json,L"custom_status.end_user_description",L"<string>");
CkJsonObjectW_UpdateString(json,L"custom_status.end_user_label",L"<string>");
CkJsonObjectW_UpdateString(json,L"custom_status.status_category",L"new");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_PostJson3(http,L"https://example.zendesk.com/api/v2/custom_statuses",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Status_category = CkJsonObjectW_stringOf(jResp,L"custom_status.status_category");
Agent_label = CkJsonObjectW_stringOf(jResp,L"custom_status.agent_label");
Active = CkJsonObjectW_stringOf(jResp,L"custom_status.active");
Created_at = CkJsonObjectW_stringOf(jResp,L"custom_status.created_at");
Default = CkJsonObjectW_stringOf(jResp,L"custom_status.default");
Description = CkJsonObjectW_stringOf(jResp,L"custom_status.description");
End_user_description = CkJsonObjectW_stringOf(jResp,L"custom_status.end_user_description");
End_user_label = CkJsonObjectW_stringOf(jResp,L"custom_status.end_user_label");
Id = CkJsonObjectW_stringOf(jResp,L"custom_status.id");
Raw_agent_label = CkJsonObjectW_stringOf(jResp,L"custom_status.raw_agent_label");
Raw_description = CkJsonObjectW_stringOf(jResp,L"custom_status.raw_description");
Raw_end_user_description = CkJsonObjectW_stringOf(jResp,L"custom_status.raw_end_user_description");
Raw_end_user_label = CkJsonObjectW_stringOf(jResp,L"custom_status.raw_end_user_label");
Updated_at = CkJsonObjectW_stringOf(jResp,L"custom_status.updated_at");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(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}"
}
]
}
