unicodeC / Support API / Update Item
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 *content;
const wchar_t *locale_id;
const wchar_t *active;
const wchar_t *created_at;
const wchar_t *default;
const wchar_t *id;
const wchar_t *outdated;
const wchar_t *updated_at;
const wchar_t *url;
const wchar_t *Name;
const wchar_t *Default_locale_id;
const wchar_t *Created_at;
const wchar_t *Id;
const wchar_t *Outdated;
const wchar_t *Placeholder;
const wchar_t *Updated_at;
const wchar_t *v_Url;
int i;
int count_i;
// 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"PUT",L"https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_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)
// {
// "item": {
// "name": "<string>",
// "default_locale_id": "<integer>",
// "variants": [
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ],
// "created_at": "<dateTime>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "placeholder": "<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.
Name = CkJsonObjectW_stringOf(jResp,L"item.name");
Default_locale_id = CkJsonObjectW_stringOf(jResp,L"item.default_locale_id");
Created_at = CkJsonObjectW_stringOf(jResp,L"item.created_at");
Id = CkJsonObjectW_stringOf(jResp,L"item.id");
Outdated = CkJsonObjectW_stringOf(jResp,L"item.outdated");
Placeholder = CkJsonObjectW_stringOf(jResp,L"item.placeholder");
Updated_at = CkJsonObjectW_stringOf(jResp,L"item.updated_at");
v_Url = CkJsonObjectW_stringOf(jResp,L"item.url");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"item.variants");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
content = CkJsonObjectW_stringOf(jResp,L"item.variants[i].content");
locale_id = CkJsonObjectW_stringOf(jResp,L"item.variants[i].locale_id");
active = CkJsonObjectW_stringOf(jResp,L"item.variants[i].active");
created_at = CkJsonObjectW_stringOf(jResp,L"item.variants[i].created_at");
default = CkJsonObjectW_stringOf(jResp,L"item.variants[i].default");
id = CkJsonObjectW_stringOf(jResp,L"item.variants[i].id");
outdated = CkJsonObjectW_stringOf(jResp,L"item.variants[i].outdated");
updated_at = CkJsonObjectW_stringOf(jResp,L"item.variants[i].updated_at");
url = CkJsonObjectW_stringOf(jResp,L"item.variants[i].url");
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id
Postman Collection Item JSON
{
"name": "Update Item",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
":dynamic_content_item_id"
],
"variable": [
{
"key": "dynamic_content_item_id",
"value": "<integer>"
}
]
},
"description": "The only attribute you can change is the name.\n\nTo add a variant to the item, or to update or delete the variants of the item, use the [Item Variants API](/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#update-many-variants).\n\n#### Allowed For\n\n* Admins, Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
":dynamic_content_item_id"
],
"variable": [
{
"key": "dynamic_content_item_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"item\": {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
