Unicode C++ / Support API / Update a Brand
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); json.UpdateString(L"brand.name",L"<string>"); json.UpdateString(L"brand.subdomain",L"<string>"); json.UpdateString(L"brand.active",L"<boolean>"); json.UpdateString(L"brand.brand_url",L"<string>"); json.UpdateString(L"brand.created_at",L"<dateTime>"); json.UpdateString(L"brand.default",L"<boolean>"); json.UpdateString(L"brand.has_help_center",L"<boolean>"); json.UpdateString(L"brand.help_center_state",L"enabled"); json.UpdateString(L"brand.host_mapping",L"<string>"); json.UpdateString(L"brand.id",L"<integer>"); json.UpdateString(L"brand.is_deleted",L"<boolean>"); json.UpdateString(L"brand.logo.content_type",L"<string>"); json.UpdateString(L"brand.logo.content_url",L"<string>"); json.UpdateString(L"brand.logo.deleted",L"<boolean>"); json.UpdateString(L"brand.logo.file_name",L"<string>"); json.UpdateString(L"brand.logo.height",L"<string>"); json.UpdateString(L"brand.logo.id",L"<integer>"); json.UpdateString(L"brand.logo.inline",L"<boolean>"); json.UpdateString(L"brand.logo.malware_access_override",L"<boolean>"); json.UpdateString(L"brand.logo.malware_scan_result",L"<string>"); json.UpdateString(L"brand.logo.mapped_content_url",L"<string>"); json.UpdateString(L"brand.logo.size",L"<integer>"); json.UpdateString(L"brand.logo.url",L"<string>"); json.UpdateString(L"brand.logo.width",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[0].content_type",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[0].content_url",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[0].deleted",L"<boolean>"); json.UpdateString(L"brand.logo.thumbnails[0].file_name",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[0].height",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[0].id",L"<integer>"); json.UpdateString(L"brand.logo.thumbnails[0].inline",L"<boolean>"); json.UpdateString(L"brand.logo.thumbnails[0].malware_access_override",L"<boolean>"); json.UpdateString(L"brand.logo.thumbnails[0].malware_scan_result",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[0].mapped_content_url",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[0].size",L"<integer>"); json.UpdateString(L"brand.logo.thumbnails[0].url",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[0].width",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[1].content_type",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[1].content_url",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[1].deleted",L"<boolean>"); json.UpdateString(L"brand.logo.thumbnails[1].file_name",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[1].height",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[1].id",L"<integer>"); json.UpdateString(L"brand.logo.thumbnails[1].inline",L"<boolean>"); json.UpdateString(L"brand.logo.thumbnails[1].malware_access_override",L"<boolean>"); json.UpdateString(L"brand.logo.thumbnails[1].malware_scan_result",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[1].mapped_content_url",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[1].size",L"<integer>"); json.UpdateString(L"brand.logo.thumbnails[1].url",L"<string>"); json.UpdateString(L"brand.logo.thumbnails[1].width",L"<string>"); json.UpdateString(L"brand.signature_template",L"<string>"); json.UpdateString(L"brand.ticket_form_ids",L"<array>"); json.UpdateString(L"brand.updated_at",L"<dateTime>"); json.UpdateString(L"brand.url",L"<string>"); json.EmitSb(sbRequestBody); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); content_type = jResp.stringOf(L"brand.logo.thumbnails[i].content_type"); content_url = jResp.stringOf(L"brand.logo.thumbnails[i].content_url"); deleted = jResp.stringOf(L"brand.logo.thumbnails[i].deleted"); file_name = jResp.stringOf(L"brand.logo.thumbnails[i].file_name"); height = jResp.stringOf(L"brand.logo.thumbnails[i].height"); id = jResp.stringOf(L"brand.logo.thumbnails[i].id"); inline = jResp.stringOf(L"brand.logo.thumbnails[i].inline"); malware_access_override = jResp.stringOf(L"brand.logo.thumbnails[i].malware_access_override"); malware_scan_result = jResp.stringOf(L"brand.logo.thumbnails[i].malware_scan_result"); mapped_content_url = jResp.stringOf(L"brand.logo.thumbnails[i].mapped_content_url"); size = jResp.stringOf(L"brand.logo.thumbnails[i].size"); url = jResp.stringOf(L"brand.logo.thumbnails[i].url"); width = jResp.stringOf(L"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}"
}
]
}