Unicode C++ / Support API / Create Custom Object Field
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); 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>"); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); 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}"
}
]
}