C / Support API / Create Custom Object Record
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *Name;
const char *Created_at;
const char *Created_by_user_id;
const char *Do8;
const char *Adipisicing_e;
const char *Commodo0;
const char *Sunta4;
const char *Custom_object_key;
const char *External_id;
const char *Id;
const char *Updated_at;
const char *Updated_by_user_id;
const char *v_Url;
// 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_object_record": {
// "name": "<string>",
// "created_at": "<dateTime>",
// "created_by_user_id": "<string>",
// "custom_object_fields": {
// "do8": "<string>",
// "adipisicing_e": "<string>",
// "commodo0": "<string>",
// "sunta4": "<string>"
// },
// "custom_object_key": "<string>",
// "external_id": "<string>",
// "id": "<string>",
// "updated_at": "<dateTime>",
// "updated_by_user_id": "<string>",
// "url": "<string>"
// }
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"custom_object_record.name","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.created_at","<dateTime>");
CkJsonObject_UpdateString(json,"custom_object_record.created_by_user_id","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.custom_object_fields.do8","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.custom_object_fields.adipisicing_e","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.custom_object_fields.commodo0","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.custom_object_fields.sunta4","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.custom_object_key","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.external_id","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.id","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.updated_at","<dateTime>");
CkJsonObject_UpdateString(json,"custom_object_record.updated_by_user_id","<string>");
CkJsonObject_UpdateString(json,"custom_object_record.url","<string>");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_PostJson3(http,"https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records","application/json",json);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "custom_object_record": {
// "name": "<string>",
// "created_at": "<dateTime>",
// "created_by_user_id": "<string>",
// "custom_object_fields": {
// "do8": "<string>",
// "adipisicing_e": "<string>",
// "commodo0": "<string>",
// "sunta4": "<string>"
// },
// "custom_object_key": "<string>",
// "external_id": "<string>",
// "id": "<string>",
// "updated_at": "<dateTime>",
// "updated_by_user_id": "<string>",
// "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.
Name = CkJsonObject_stringOf(jResp,"custom_object_record.name");
Created_at = CkJsonObject_stringOf(jResp,"custom_object_record.created_at");
Created_by_user_id = CkJsonObject_stringOf(jResp,"custom_object_record.created_by_user_id");
Do8 = CkJsonObject_stringOf(jResp,"custom_object_record.custom_object_fields.do8");
Adipisicing_e = CkJsonObject_stringOf(jResp,"custom_object_record.custom_object_fields.adipisicing_e");
Commodo0 = CkJsonObject_stringOf(jResp,"custom_object_record.custom_object_fields.commodo0");
Sunta4 = CkJsonObject_stringOf(jResp,"custom_object_record.custom_object_fields.sunta4");
Custom_object_key = CkJsonObject_stringOf(jResp,"custom_object_record.custom_object_key");
External_id = CkJsonObject_stringOf(jResp,"custom_object_record.external_id");
Id = CkJsonObject_stringOf(jResp,"custom_object_record.id");
Updated_at = CkJsonObject_stringOf(jResp,"custom_object_record.updated_at");
Updated_by_user_id = CkJsonObject_stringOf(jResp,"custom_object_record.updated_by_user_id");
v_Url = CkJsonObject_stringOf(jResp,"custom_object_record.url");
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"custom_object_record": {
"name": "<string>",
"created_at": "<dateTime>",
"created_by_user_id": "<string>",
"custom_object_fields": {
"do8": "<string>",
"adipisicing_e": "<string>",
"commodo0": "<string>",
"sunta4": "<string>"
},
"custom_object_key": "<string>",
"external_id": "<string>",
"id": "<string>",
"updated_at": "<dateTime>",
"updated_by_user_id": "<string>",
"url": "<string>"
}
}'
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records
Postman Collection Item JSON
{
"name": "Create Custom Object Record",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_object_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
}
]
},
"description": "Creates a custom object record according to all the properties described by a custom object definition\n\n#### Allowed For\n\n* Agents\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_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records"
],
"variable": [
{
"key": "custom_object_key"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_object_record\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"created_by_user_id\": \"<string>\",\n \"custom_object_fields\": {\n \"do8\": \"<string>\",\n \"adipisicing_e\": \"<string>\",\n \"commodo0\": \"<string>\",\n \"sunta4\": \"<string>\"\n },\n \"custom_object_key\": \"<string>\",\n \"external_id\": \"<string>\",\n \"id\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"updated_by_user_id\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
