C++ / Support API / Update a Brand
Back to Collection Items
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("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.
// {
// "brand": {
// "name": "<string>",
// "subdomain": "<string>",
// "active": "<boolean>",
// "brand_url": "<string>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "has_help_center": "<boolean>",
// "help_center_state": "enabled",
// "host_mapping": "<string>",
// "id": "<integer>",
// "is_deleted": "<boolean>",
// "logo": {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>",
// "thumbnails": [
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>"
// },
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>"
// }
// ]
// },
// "signature_template": "<string>",
// "ticket_form_ids": "<array>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// }
CkJsonObject json;
json.UpdateString("brand.name","<string>");
json.UpdateString("brand.subdomain","<string>");
json.UpdateString("brand.active","<boolean>");
json.UpdateString("brand.brand_url","<string>");
json.UpdateString("brand.created_at","<dateTime>");
json.UpdateString("brand.default","<boolean>");
json.UpdateString("brand.has_help_center","<boolean>");
json.UpdateString("brand.help_center_state","enabled");
json.UpdateString("brand.host_mapping","<string>");
json.UpdateString("brand.id","<integer>");
json.UpdateString("brand.is_deleted","<boolean>");
json.UpdateString("brand.logo.content_type","<string>");
json.UpdateString("brand.logo.content_url","<string>");
json.UpdateString("brand.logo.deleted","<boolean>");
json.UpdateString("brand.logo.file_name","<string>");
json.UpdateString("brand.logo.height","<string>");
json.UpdateString("brand.logo.id","<integer>");
json.UpdateString("brand.logo.inline","<boolean>");
json.UpdateString("brand.logo.malware_access_override","<boolean>");
json.UpdateString("brand.logo.malware_scan_result","<string>");
json.UpdateString("brand.logo.mapped_content_url","<string>");
json.UpdateString("brand.logo.size","<integer>");
json.UpdateString("brand.logo.url","<string>");
json.UpdateString("brand.logo.width","<string>");
json.UpdateString("brand.logo.thumbnails[0].content_type","<string>");
json.UpdateString("brand.logo.thumbnails[0].content_url","<string>");
json.UpdateString("brand.logo.thumbnails[0].deleted","<boolean>");
json.UpdateString("brand.logo.thumbnails[0].file_name","<string>");
json.UpdateString("brand.logo.thumbnails[0].height","<string>");
json.UpdateString("brand.logo.thumbnails[0].id","<integer>");
json.UpdateString("brand.logo.thumbnails[0].inline","<boolean>");
json.UpdateString("brand.logo.thumbnails[0].malware_access_override","<boolean>");
json.UpdateString("brand.logo.thumbnails[0].malware_scan_result","<string>");
json.UpdateString("brand.logo.thumbnails[0].mapped_content_url","<string>");
json.UpdateString("brand.logo.thumbnails[0].size","<integer>");
json.UpdateString("brand.logo.thumbnails[0].url","<string>");
json.UpdateString("brand.logo.thumbnails[0].width","<string>");
json.UpdateString("brand.logo.thumbnails[1].content_type","<string>");
json.UpdateString("brand.logo.thumbnails[1].content_url","<string>");
json.UpdateString("brand.logo.thumbnails[1].deleted","<boolean>");
json.UpdateString("brand.logo.thumbnails[1].file_name","<string>");
json.UpdateString("brand.logo.thumbnails[1].height","<string>");
json.UpdateString("brand.logo.thumbnails[1].id","<integer>");
json.UpdateString("brand.logo.thumbnails[1].inline","<boolean>");
json.UpdateString("brand.logo.thumbnails[1].malware_access_override","<boolean>");
json.UpdateString("brand.logo.thumbnails[1].malware_scan_result","<string>");
json.UpdateString("brand.logo.thumbnails[1].mapped_content_url","<string>");
json.UpdateString("brand.logo.thumbnails[1].size","<integer>");
json.UpdateString("brand.logo.thumbnails[1].url","<string>");
json.UpdateString("brand.logo.thumbnails[1].width","<string>");
json.UpdateString("brand.signature_template","<string>");
json.UpdateString("brand.ticket_form_ids","<array>");
json.UpdateString("brand.updated_at","<dateTime>");
json.UpdateString("brand.url","<string>");
http.SetRequestHeader("Content-Type","application/json");
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbRequestBody;
json.EmitSb(sbRequestBody);
CkHttpResponse *resp = http.PTextSb("PUT","https://example.zendesk.com/api/v2/brands/:brand_id",sbRequestBody,"utf-8","application/json",false,false);
if (http.get_LastMethodSuccess() == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp->get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << resp->header() << "\r\n";
std::cout << "Failed." << "\r\n";
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "brand": {
// "name": "<string>",
// "subdomain": "<string>",
// "active": "<boolean>",
// "brand_url": "<string>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "has_help_center": "<boolean>",
// "help_center_state": "enabled",
// "host_mapping": "<string>",
// "id": "<integer>",
// "is_deleted": "<boolean>",
// "logo": {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>",
// "thumbnails": [
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>"
// },
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "deleted": "<boolean>",
// "file_name": "<string>",
// "height": "<string>",
// "id": "<integer>",
// "inline": "<boolean>",
// "malware_access_override": "<boolean>",
// "malware_scan_result": "<string>",
// "mapped_content_url": "<string>",
// "size": "<integer>",
// "url": "<string>",
// "width": "<string>"
// }
// ]
// },
// "signature_template": "<string>",
// "ticket_form_ids": "<array>",
// "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 char *content_type = 0;
const char *content_url = 0;
const char *deleted = 0;
const char *file_name = 0;
const char *height = 0;
const char *id = 0;
const char *inline = 0;
const char *malware_access_override = 0;
const char *malware_scan_result = 0;
const char *mapped_content_url = 0;
const char *size = 0;
const char *url = 0;
const char *width = 0;
const char *Name = jResp.stringOf("brand.name");
const char *Subdomain = jResp.stringOf("brand.subdomain");
const char *Active = jResp.stringOf("brand.active");
const char *Brand_url = jResp.stringOf("brand.brand_url");
const char *Created_at = jResp.stringOf("brand.created_at");
const char *Default = jResp.stringOf("brand.default");
const char *Has_help_center = jResp.stringOf("brand.has_help_center");
const char *Help_center_state = jResp.stringOf("brand.help_center_state");
const char *Host_mapping = jResp.stringOf("brand.host_mapping");
const char *Id = jResp.stringOf("brand.id");
const char *Is_deleted = jResp.stringOf("brand.is_deleted");
const char *Content_type = jResp.stringOf("brand.logo.content_type");
const char *Content_url = jResp.stringOf("brand.logo.content_url");
const char *Deleted = jResp.stringOf("brand.logo.deleted");
const char *File_name = jResp.stringOf("brand.logo.file_name");
const char *Height = jResp.stringOf("brand.logo.height");
const char *LogoId = jResp.stringOf("brand.logo.id");
const char *Inline = jResp.stringOf("brand.logo.inline");
const char *Malware_access_override = jResp.stringOf("brand.logo.malware_access_override");
const char *Malware_scan_result = jResp.stringOf("brand.logo.malware_scan_result");
const char *Mapped_content_url = jResp.stringOf("brand.logo.mapped_content_url");
const char *Size = jResp.stringOf("brand.logo.size");
const char *v_Url = jResp.stringOf("brand.logo.url");
const char *Width = jResp.stringOf("brand.logo.width");
const char *Signature_template = jResp.stringOf("brand.signature_template");
const char *Ticket_form_ids = jResp.stringOf("brand.ticket_form_ids");
const char *Updated_at = jResp.stringOf("brand.updated_at");
const char *brandUrl = jResp.stringOf("brand.url");
int i = 0;
int count_i = jResp.SizeOfArray("brand.logo.thumbnails");
while (i < count_i) {
jResp.put_I(i);
content_type = jResp.stringOf("brand.logo.thumbnails[i].content_type");
content_url = jResp.stringOf("brand.logo.thumbnails[i].content_url");
deleted = jResp.stringOf("brand.logo.thumbnails[i].deleted");
file_name = jResp.stringOf("brand.logo.thumbnails[i].file_name");
height = jResp.stringOf("brand.logo.thumbnails[i].height");
id = jResp.stringOf("brand.logo.thumbnails[i].id");
inline = jResp.stringOf("brand.logo.thumbnails[i].inline");
malware_access_override = jResp.stringOf("brand.logo.thumbnails[i].malware_access_override");
malware_scan_result = jResp.stringOf("brand.logo.thumbnails[i].malware_scan_result");
mapped_content_url = jResp.stringOf("brand.logo.thumbnails[i].mapped_content_url");
size = jResp.stringOf("brand.logo.thumbnails[i].size");
url = jResp.stringOf("brand.logo.thumbnails[i].url");
width = jResp.stringOf("brand.logo.thumbnails[i].width");
i = i + 1;
}
}
Curl Command
curl -u login:password -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"brand": {
"name": "<string>",
"subdomain": "<string>",
"active": "<boolean>",
"brand_url": "<string>",
"created_at": "<dateTime>",
"default": "<boolean>",
"has_help_center": "<boolean>",
"help_center_state": "enabled",
"host_mapping": "<string>",
"id": "<integer>",
"is_deleted": "<boolean>",
"logo": {
"content_type": "<string>",
"content_url": "<string>",
"deleted": "<boolean>",
"file_name": "<string>",
"height": "<string>",
"id": "<integer>",
"inline": "<boolean>",
"malware_access_override": "<boolean>",
"malware_scan_result": "<string>",
"mapped_content_url": "<string>",
"size": "<integer>",
"url": "<string>",
"width": "<string>",
"thumbnails": [
{
"content_type": "<string>",
"content_url": "<string>",
"deleted": "<boolean>",
"file_name": "<string>",
"height": "<string>",
"id": "<integer>",
"inline": "<boolean>",
"malware_access_override": "<boolean>",
"malware_scan_result": "<string>",
"mapped_content_url": "<string>",
"size": "<integer>",
"url": "<string>",
"width": "<string>"
},
{
"content_type": "<string>",
"content_url": "<string>",
"deleted": "<boolean>",
"file_name": "<string>",
"height": "<string>",
"id": "<integer>",
"inline": "<boolean>",
"malware_access_override": "<boolean>",
"malware_scan_result": "<string>",
"mapped_content_url": "<string>",
"size": "<integer>",
"url": "<string>",
"width": "<string>"
}
]
},
"signature_template": "<string>",
"ticket_form_ids": "<array>",
"updated_at": "<dateTime>",
"url": "<string>"
}
}'
https://example.zendesk.com/api/v2/brands/:brand_id
Postman Collection Item JSON
{
"name": "Update a Brand",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"brand\": {\n \"name\": \"<string>\",\n \"subdomain\": \"<string>\",\n \"active\": \"<boolean>\",\n \"brand_url\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"has_help_center\": \"<boolean>\",\n \"help_center_state\": \"enabled\",\n \"host_mapping\": \"<string>\",\n \"id\": \"<integer>\",\n \"is_deleted\": \"<boolean>\",\n \"logo\": {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n },\n \"signature_template\": \"<string>\",\n \"ticket_form_ids\": \"<array>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/brands/:brand_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"brands",
":brand_id"
],
"variable": [
{
"key": "brand_id",
"value": "<integer>"
}
]
},
"description": "Returns an updated brand.\n\n#### Allowed for\n* Admins\n\n#### Updating a Brand's Image\nA brand image can be updated by uploading a local file using the update brand endpoint. See the **Using curl** sections below for more information."
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "PUT",
"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 \"brand\": {\n \"name\": \"<string>\",\n \"subdomain\": \"<string>\",\n \"active\": \"<boolean>\",\n \"brand_url\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"has_help_center\": \"<boolean>\",\n \"help_center_state\": \"enabled\",\n \"host_mapping\": \"<string>\",\n \"id\": \"<integer>\",\n \"is_deleted\": \"<boolean>\",\n \"logo\": {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n },\n \"signature_template\": \"<string>\",\n \"ticket_form_ids\": \"<array>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/brands/:brand_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"brands",
":brand_id"
],
"variable": [
{
"key": "brand_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"brand\": {\n \"name\": \"<string>\",\n \"subdomain\": \"<string>\",\n \"active\": \"<boolean>\",\n \"brand_url\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"has_help_center\": \"<boolean>\",\n \"help_center_state\": \"enabled\",\n \"host_mapping\": \"<string>\",\n \"id\": \"<integer>\",\n \"is_deleted\": \"<boolean>\",\n \"logo\": {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n },\n \"signature_template\": \"<string>\",\n \"ticket_form_ids\": \"<array>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
