Swift / Support API / Update a Brand
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
http.BasicAuth = true
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>"
// }
// }
let json = CkoJsonObject()
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")
let sbRequestBody = CkoStringBuilder()
json.EmitSb(sbRequestBody)
var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://example.zendesk.com/api/v2/brands/:brand_id", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var content_type: String?
var content_url: String?
var deleted: String?
var file_name: String?
var height: String?
var id: String?
var inline: String?
var malware_access_override: String?
var malware_scan_result: String?
var mapped_content_url: String?
var size: String?
var url: String?
var width: String?
var Name: String? = jResp.StringOf("brand.name")
var Subdomain: String? = jResp.StringOf("brand.subdomain")
var Active: String? = jResp.StringOf("brand.active")
var Brand_url: String? = jResp.StringOf("brand.brand_url")
var Created_at: String? = jResp.StringOf("brand.created_at")
var Default: String? = jResp.StringOf("brand.default")
var Has_help_center: String? = jResp.StringOf("brand.has_help_center")
var Help_center_state: String? = jResp.StringOf("brand.help_center_state")
var Host_mapping: String? = jResp.StringOf("brand.host_mapping")
var Id: String? = jResp.StringOf("brand.id")
var Is_deleted: String? = jResp.StringOf("brand.is_deleted")
var Content_type: String? = jResp.StringOf("brand.logo.content_type")
var Content_url: String? = jResp.StringOf("brand.logo.content_url")
var Deleted: String? = jResp.StringOf("brand.logo.deleted")
var File_name: String? = jResp.StringOf("brand.logo.file_name")
var Height: String? = jResp.StringOf("brand.logo.height")
var LogoId: String? = jResp.StringOf("brand.logo.id")
var Inline: String? = jResp.StringOf("brand.logo.inline")
var Malware_access_override: String? = jResp.StringOf("brand.logo.malware_access_override")
var Malware_scan_result: String? = jResp.StringOf("brand.logo.malware_scan_result")
var Mapped_content_url: String? = jResp.StringOf("brand.logo.mapped_content_url")
var Size: String? = jResp.StringOf("brand.logo.size")
var v_Url: String? = jResp.StringOf("brand.logo.url")
var Width: String? = jResp.StringOf("brand.logo.width")
var Signature_template: String? = jResp.StringOf("brand.signature_template")
var Ticket_form_ids: String? = jResp.StringOf("brand.ticket_form_ids")
var Updated_at: String? = jResp.StringOf("brand.updated_at")
var brandUrl: String? = jResp.StringOf("brand.url")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("brand.logo.thumbnails").intValue
while i < count_i {
jResp.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}"
}
]
}
