unicodeCpp / Support API / Create Custom Object Field
Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"login");
http.put_Password(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_object_field": {
// "key": "<string>",
// "type": "<string>",
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "custom_field_options": [
// {
// "name": "<string>",
// "value": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_name": "<string>",
// "url": "<string>"
// },
// {
// "name": "<string>",
// "value": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_name": "<string>",
// "url": "<string>"
// }
// ],
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_description": "<string>",
// "raw_title": "<string>",
// "regexp_for_validation": "<string>",
// "relationship_filter": {},
// "relationship_target_type": "<string>",
// "system": "<boolean>",
// "tag": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// }
CkJsonObjectW json;
json.UpdateString(L"custom_object_field.key",L"<string>");
json.UpdateString(L"custom_object_field.type",L"<string>");
json.UpdateString(L"custom_object_field.title",L"<string>");
json.UpdateString(L"custom_object_field.active",L"<boolean>");
json.UpdateString(L"custom_object_field.created_at",L"<dateTime>");
json.UpdateString(L"custom_object_field.custom_field_options[0].name",L"<string>");
json.UpdateString(L"custom_object_field.custom_field_options[0].value",L"<string>");
json.UpdateString(L"custom_object_field.custom_field_options[0].id",L"<integer>");
json.UpdateString(L"custom_object_field.custom_field_options[0].position",L"<integer>");
json.UpdateString(L"custom_object_field.custom_field_options[0].raw_name",L"<string>");
json.UpdateString(L"custom_object_field.custom_field_options[0].url",L"<string>");
json.UpdateString(L"custom_object_field.custom_field_options[1].name",L"<string>");
json.UpdateString(L"custom_object_field.custom_field_options[1].value",L"<string>");
json.UpdateString(L"custom_object_field.custom_field_options[1].id",L"<integer>");
json.UpdateString(L"custom_object_field.custom_field_options[1].position",L"<integer>");
json.UpdateString(L"custom_object_field.custom_field_options[1].raw_name",L"<string>");
json.UpdateString(L"custom_object_field.custom_field_options[1].url",L"<string>");
json.UpdateString(L"custom_object_field.description",L"<string>");
json.UpdateString(L"custom_object_field.id",L"<integer>");
json.UpdateString(L"custom_object_field.position",L"<integer>");
json.UpdateString(L"custom_object_field.raw_description",L"<string>");
json.UpdateString(L"custom_object_field.raw_title",L"<string>");
json.UpdateString(L"custom_object_field.regexp_for_validation",L"<string>");
json.UpdateNewObject(L"custom_object_field.relationship_filter");
json.UpdateString(L"custom_object_field.relationship_target_type",L"<string>");
json.UpdateString(L"custom_object_field.system",L"<boolean>");
json.UpdateString(L"custom_object_field.tag",L"<string>");
json.UpdateString(L"custom_object_field.updated_at",L"<dateTime>");
json.UpdateString(L"custom_object_field.url",L"<string>");
http.SetRequestHeader(L"Content-Type",L"application/json");
http.SetRequestHeader(L"Accept",L"application/json");
CkHttpResponseW *resp = http.PostJson3(L"https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields",L"application/json",json);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "custom_object_field": {
// "key": "<string>",
// "type": "<string>",
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "custom_field_options": [
// {
// "name": "<string>",
// "value": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_name": "<string>",
// "url": "<string>"
// },
// {
// "name": "<string>",
// "value": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_name": "<string>",
// "url": "<string>"
// }
// ],
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_description": "<string>",
// "raw_title": "<string>",
// "regexp_for_validation": "<string>",
// "relationship_filter": {},
// "relationship_target_type": "<string>",
// "system": "<boolean>",
// "tag": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// }
// 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.
const wchar_t *name = 0;
const wchar_t *value = 0;
const wchar_t *id = 0;
const wchar_t *position = 0;
const wchar_t *raw_name = 0;
const wchar_t *url = 0;
const wchar_t *Key = jResp.stringOf(L"custom_object_field.key");
const wchar_t *v_Type = jResp.stringOf(L"custom_object_field.type");
const wchar_t *Title = jResp.stringOf(L"custom_object_field.title");
const wchar_t *Active = jResp.stringOf(L"custom_object_field.active");
const wchar_t *Created_at = jResp.stringOf(L"custom_object_field.created_at");
const wchar_t *Description = jResp.stringOf(L"custom_object_field.description");
const wchar_t *Id = jResp.stringOf(L"custom_object_field.id");
const wchar_t *Position = jResp.stringOf(L"custom_object_field.position");
const wchar_t *Raw_description = jResp.stringOf(L"custom_object_field.raw_description");
const wchar_t *Raw_title = jResp.stringOf(L"custom_object_field.raw_title");
const wchar_t *Regexp_for_validation = jResp.stringOf(L"custom_object_field.regexp_for_validation");
const wchar_t *Relationship_target_type = jResp.stringOf(L"custom_object_field.relationship_target_type");
const wchar_t *System = jResp.stringOf(L"custom_object_field.system");
const wchar_t *Tag = jResp.stringOf(L"custom_object_field.tag");
const wchar_t *Updated_at = jResp.stringOf(L"custom_object_field.updated_at");
const wchar_t *v_Url = jResp.stringOf(L"custom_object_field.url");
int i = 0;
int count_i = jResp.SizeOfArray(L"custom_object_field.custom_field_options");
while (i < count_i) {
jResp.put_I(i);
name = jResp.stringOf(L"custom_object_field.custom_field_options[i].name");
value = jResp.stringOf(L"custom_object_field.custom_field_options[i].value");
id = jResp.stringOf(L"custom_object_field.custom_field_options[i].id");
position = jResp.stringOf(L"custom_object_field.custom_field_options[i].position");
raw_name = jResp.stringOf(L"custom_object_field.custom_field_options[i].raw_name");
url = jResp.stringOf(L"custom_object_field.custom_field_options[i].url");
i = i + 1;
}
}
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"custom_object_field": {
"key": "<string>",
"type": "<string>",
"title": "<string>",
"active": "<boolean>",
"created_at": "<dateTime>",
"custom_field_options": [
{
"name": "<string>",
"value": "<string>",
"id": "<integer>",
"position": "<integer>",
"raw_name": "<string>",
"url": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"id": "<integer>",
"position": "<integer>",
"raw_name": "<string>",
"url": "<string>"
}
],
"description": "<string>",
"id": "<integer>",
"position": "<integer>",
"raw_description": "<string>",
"raw_title": "<string>",
"regexp_for_validation": "<string>",
"relationship_filter": {},
"relationship_target_type": "<string>",
"system": "<boolean>",
"tag": "<string>",
"updated_at": "<dateTime>",
"url": "<string>"
}
}'
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields
Postman Collection Item JSON
{
"name": "Create Custom Object Field",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_object_field\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
}
]
},
"description": "Creates any of the following custom field types:\n\n* text (default when no \"type\" is specified)\n* textarea\n* checkbox\n* date\n* integer\n* decimal\n* regexp\n* dropdown\n* lookup\n\nSee [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in Zendesk help.\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_object_field\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields"
],
"variable": [
{
"key": "custom_object_key"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_object_field\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
