Objective-C / Support API / Update a Brand
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"login";
http.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>"
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"brand.name" value: @"<string>"];
[json UpdateString: @"brand.subdomain" value: @"<string>"];
[json UpdateString: @"brand.active" value: @"<boolean>"];
[json UpdateString: @"brand.brand_url" value: @"<string>"];
[json UpdateString: @"brand.created_at" value: @"<dateTime>"];
[json UpdateString: @"brand.default" value: @"<boolean>"];
[json UpdateString: @"brand.has_help_center" value: @"<boolean>"];
[json UpdateString: @"brand.help_center_state" value: @"enabled"];
[json UpdateString: @"brand.host_mapping" value: @"<string>"];
[json UpdateString: @"brand.id" value: @"<integer>"];
[json UpdateString: @"brand.is_deleted" value: @"<boolean>"];
[json UpdateString: @"brand.logo.content_type" value: @"<string>"];
[json UpdateString: @"brand.logo.content_url" value: @"<string>"];
[json UpdateString: @"brand.logo.deleted" value: @"<boolean>"];
[json UpdateString: @"brand.logo.file_name" value: @"<string>"];
[json UpdateString: @"brand.logo.height" value: @"<string>"];
[json UpdateString: @"brand.logo.id" value: @"<integer>"];
[json UpdateString: @"brand.logo.inline" value: @"<boolean>"];
[json UpdateString: @"brand.logo.malware_access_override" value: @"<boolean>"];
[json UpdateString: @"brand.logo.malware_scan_result" value: @"<string>"];
[json UpdateString: @"brand.logo.mapped_content_url" value: @"<string>"];
[json UpdateString: @"brand.logo.size" value: @"<integer>"];
[json UpdateString: @"brand.logo.url" value: @"<string>"];
[json UpdateString: @"brand.logo.width" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[0].content_type" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[0].content_url" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[0].deleted" value: @"<boolean>"];
[json UpdateString: @"brand.logo.thumbnails[0].file_name" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[0].height" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[0].id" value: @"<integer>"];
[json UpdateString: @"brand.logo.thumbnails[0].inline" value: @"<boolean>"];
[json UpdateString: @"brand.logo.thumbnails[0].malware_access_override" value: @"<boolean>"];
[json UpdateString: @"brand.logo.thumbnails[0].malware_scan_result" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[0].mapped_content_url" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[0].size" value: @"<integer>"];
[json UpdateString: @"brand.logo.thumbnails[0].url" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[0].width" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[1].content_type" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[1].content_url" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[1].deleted" value: @"<boolean>"];
[json UpdateString: @"brand.logo.thumbnails[1].file_name" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[1].height" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[1].id" value: @"<integer>"];
[json UpdateString: @"brand.logo.thumbnails[1].inline" value: @"<boolean>"];
[json UpdateString: @"brand.logo.thumbnails[1].malware_access_override" value: @"<boolean>"];
[json UpdateString: @"brand.logo.thumbnails[1].malware_scan_result" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[1].mapped_content_url" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[1].size" value: @"<integer>"];
[json UpdateString: @"brand.logo.thumbnails[1].url" value: @"<string>"];
[json UpdateString: @"brand.logo.thumbnails[1].width" value: @"<string>"];
[json UpdateString: @"brand.signature_template" value: @"<string>"];
[json UpdateString: @"brand.ticket_form_ids" value: @"<array>"];
[json UpdateString: @"brand.updated_at" value: @"<dateTime>"];
[json UpdateString: @"brand.url" value: @"<string>"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://example.zendesk.com/api/v2/brands/:brand_id" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *content_type = 0;
NSString *content_url = 0;
NSString *deleted = 0;
NSString *file_name = 0;
NSString *height = 0;
NSString *id = 0;
NSString *inline = 0;
NSString *malware_access_override = 0;
NSString *malware_scan_result = 0;
NSString *mapped_content_url = 0;
NSString *size = 0;
NSString *url = 0;
NSString *width = 0;
NSString *Name = [jResp StringOf: @"brand.name"];
NSString *Subdomain = [jResp StringOf: @"brand.subdomain"];
NSString *Active = [jResp StringOf: @"brand.active"];
NSString *Brand_url = [jResp StringOf: @"brand.brand_url"];
NSString *Created_at = [jResp StringOf: @"brand.created_at"];
NSString *Default = [jResp StringOf: @"brand.default"];
NSString *Has_help_center = [jResp StringOf: @"brand.has_help_center"];
NSString *Help_center_state = [jResp StringOf: @"brand.help_center_state"];
NSString *Host_mapping = [jResp StringOf: @"brand.host_mapping"];
NSString *Id = [jResp StringOf: @"brand.id"];
NSString *Is_deleted = [jResp StringOf: @"brand.is_deleted"];
NSString *Content_type = [jResp StringOf: @"brand.logo.content_type"];
NSString *Content_url = [jResp StringOf: @"brand.logo.content_url"];
NSString *Deleted = [jResp StringOf: @"brand.logo.deleted"];
NSString *File_name = [jResp StringOf: @"brand.logo.file_name"];
NSString *Height = [jResp StringOf: @"brand.logo.height"];
NSString *LogoId = [jResp StringOf: @"brand.logo.id"];
NSString *Inline = [jResp StringOf: @"brand.logo.inline"];
NSString *Malware_access_override = [jResp StringOf: @"brand.logo.malware_access_override"];
NSString *Malware_scan_result = [jResp StringOf: @"brand.logo.malware_scan_result"];
NSString *Mapped_content_url = [jResp StringOf: @"brand.logo.mapped_content_url"];
NSString *Size = [jResp StringOf: @"brand.logo.size"];
NSString *v_Url = [jResp StringOf: @"brand.logo.url"];
NSString *Width = [jResp StringOf: @"brand.logo.width"];
NSString *Signature_template = [jResp StringOf: @"brand.signature_template"];
NSString *Ticket_form_ids = [jResp StringOf: @"brand.ticket_form_ids"];
NSString *Updated_at = [jResp StringOf: @"brand.updated_at"];
NSString *brandUrl = [jResp StringOf: @"brand.url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"brand.logo.thumbnails"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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}"
}
]
}
