unicodeC / Support API / Update Custom Object Record
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Name;
const wchar_t *Created_at;
const wchar_t *Created_by_user_id;
const wchar_t *Do8;
const wchar_t *Adipisicing_e;
const wchar_t *Commodo0;
const wchar_t *Sunta4;
const wchar_t *Custom_object_key;
const wchar_t *External_id;
const wchar_t *Id;
const wchar_t *Updated_at;
const wchar_t *Updated_by_user_id;
const wchar_t *v_Url;
// 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");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequest(http,L"PATCH",L"https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id");
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
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);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_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 = CkJsonObjectW_stringOf(jResp,L"custom_object_record.name");
Created_at = CkJsonObjectW_stringOf(jResp,L"custom_object_record.created_at");
Created_by_user_id = CkJsonObjectW_stringOf(jResp,L"custom_object_record.created_by_user_id");
Do8 = CkJsonObjectW_stringOf(jResp,L"custom_object_record.custom_object_fields.do8");
Adipisicing_e = CkJsonObjectW_stringOf(jResp,L"custom_object_record.custom_object_fields.adipisicing_e");
Commodo0 = CkJsonObjectW_stringOf(jResp,L"custom_object_record.custom_object_fields.commodo0");
Sunta4 = CkJsonObjectW_stringOf(jResp,L"custom_object_record.custom_object_fields.sunta4");
Custom_object_key = CkJsonObjectW_stringOf(jResp,L"custom_object_record.custom_object_key");
External_id = CkJsonObjectW_stringOf(jResp,L"custom_object_record.external_id");
Id = CkJsonObjectW_stringOf(jResp,L"custom_object_record.id");
Updated_at = CkJsonObjectW_stringOf(jResp,L"custom_object_record.updated_at");
Updated_by_user_id = CkJsonObjectW_stringOf(jResp,L"custom_object_record.updated_by_user_id");
v_Url = CkJsonObjectW_stringOf(jResp,L"custom_object_record.url");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -u login:password -X PATCH
-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id
Postman Collection Item JSON
{
"name": "Update Custom Object Record",
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records",
":custom_object_record_id"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
},
{
"key": "custom_object_record_id",
"value": "<string>"
}
]
},
"description": "Updates an individual custom object record. The updating rules are as follows:\n* Takes a `custom_object_record` object that specifies the properties to update\n* The custom object fields should be nested inside a `custom_object_fields` object\n#### Allowed For\n* Agents"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"records",
":custom_object_record_id"
],
"variable": [
{
"key": "custom_object_key"
},
{
"key": "custom_object_record_id"
}
]
}
},
"status": "OK",
"code": 200,
"_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}"
}
]
}
