lianja / Support API / Update a Brand
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.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>"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("brand.name","<string>")
loJson.UpdateString("brand.subdomain","<string>")
loJson.UpdateString("brand.active","<boolean>")
loJson.UpdateString("brand.brand_url","<string>")
loJson.UpdateString("brand.created_at","<dateTime>")
loJson.UpdateString("brand.default","<boolean>")
loJson.UpdateString("brand.has_help_center","<boolean>")
loJson.UpdateString("brand.help_center_state","enabled")
loJson.UpdateString("brand.host_mapping","<string>")
loJson.UpdateString("brand.id","<integer>")
loJson.UpdateString("brand.is_deleted","<boolean>")
loJson.UpdateString("brand.logo.content_type","<string>")
loJson.UpdateString("brand.logo.content_url","<string>")
loJson.UpdateString("brand.logo.deleted","<boolean>")
loJson.UpdateString("brand.logo.file_name","<string>")
loJson.UpdateString("brand.logo.height","<string>")
loJson.UpdateString("brand.logo.id","<integer>")
loJson.UpdateString("brand.logo.inline","<boolean>")
loJson.UpdateString("brand.logo.malware_access_override","<boolean>")
loJson.UpdateString("brand.logo.malware_scan_result","<string>")
loJson.UpdateString("brand.logo.mapped_content_url","<string>")
loJson.UpdateString("brand.logo.size","<integer>")
loJson.UpdateString("brand.logo.url","<string>")
loJson.UpdateString("brand.logo.width","<string>")
loJson.UpdateString("brand.logo.thumbnails[0].content_type","<string>")
loJson.UpdateString("brand.logo.thumbnails[0].content_url","<string>")
loJson.UpdateString("brand.logo.thumbnails[0].deleted","<boolean>")
loJson.UpdateString("brand.logo.thumbnails[0].file_name","<string>")
loJson.UpdateString("brand.logo.thumbnails[0].height","<string>")
loJson.UpdateString("brand.logo.thumbnails[0].id","<integer>")
loJson.UpdateString("brand.logo.thumbnails[0].inline","<boolean>")
loJson.UpdateString("brand.logo.thumbnails[0].malware_access_override","<boolean>")
loJson.UpdateString("brand.logo.thumbnails[0].malware_scan_result","<string>")
loJson.UpdateString("brand.logo.thumbnails[0].mapped_content_url","<string>")
loJson.UpdateString("brand.logo.thumbnails[0].size","<integer>")
loJson.UpdateString("brand.logo.thumbnails[0].url","<string>")
loJson.UpdateString("brand.logo.thumbnails[0].width","<string>")
loJson.UpdateString("brand.logo.thumbnails[1].content_type","<string>")
loJson.UpdateString("brand.logo.thumbnails[1].content_url","<string>")
loJson.UpdateString("brand.logo.thumbnails[1].deleted","<boolean>")
loJson.UpdateString("brand.logo.thumbnails[1].file_name","<string>")
loJson.UpdateString("brand.logo.thumbnails[1].height","<string>")
loJson.UpdateString("brand.logo.thumbnails[1].id","<integer>")
loJson.UpdateString("brand.logo.thumbnails[1].inline","<boolean>")
loJson.UpdateString("brand.logo.thumbnails[1].malware_access_override","<boolean>")
loJson.UpdateString("brand.logo.thumbnails[1].malware_scan_result","<string>")
loJson.UpdateString("brand.logo.thumbnails[1].mapped_content_url","<string>")
loJson.UpdateString("brand.logo.thumbnails[1].size","<integer>")
loJson.UpdateString("brand.logo.thumbnails[1].url","<string>")
loJson.UpdateString("brand.logo.thumbnails[1].width","<string>")
loJson.UpdateString("brand.signature_template","<string>")
loJson.UpdateString("brand.ticket_form_ids","<array>")
loJson.UpdateString("brand.updated_at","<dateTime>")
loJson.UpdateString("brand.url","<string>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/brands/:brand_id",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcName = loJResp.StringOf("brand.name")
lcSubdomain = loJResp.StringOf("brand.subdomain")
lcActive = loJResp.StringOf("brand.active")
lcBrand_url = loJResp.StringOf("brand.brand_url")
lcCreated_at = loJResp.StringOf("brand.created_at")
lcDefault = loJResp.StringOf("brand.default")
lcHas_help_center = loJResp.StringOf("brand.has_help_center")
lcHelp_center_state = loJResp.StringOf("brand.help_center_state")
lcHost_mapping = loJResp.StringOf("brand.host_mapping")
lcId = loJResp.StringOf("brand.id")
lcIs_deleted = loJResp.StringOf("brand.is_deleted")
lcContent_type = loJResp.StringOf("brand.logo.content_type")
lcContent_url = loJResp.StringOf("brand.logo.content_url")
lcDeleted = loJResp.StringOf("brand.logo.deleted")
lcFile_name = loJResp.StringOf("brand.logo.file_name")
lcHeight = loJResp.StringOf("brand.logo.height")
lcLogoId = loJResp.StringOf("brand.logo.id")
lcInline = loJResp.StringOf("brand.logo.inline")
lcMalware_access_override = loJResp.StringOf("brand.logo.malware_access_override")
lcMalware_scan_result = loJResp.StringOf("brand.logo.malware_scan_result")
lcMapped_content_url = loJResp.StringOf("brand.logo.mapped_content_url")
lcSize = loJResp.StringOf("brand.logo.size")
lcV_Url = loJResp.StringOf("brand.logo.url")
lcWidth = loJResp.StringOf("brand.logo.width")
lcSignature_template = loJResp.StringOf("brand.signature_template")
lcTicket_form_ids = loJResp.StringOf("brand.ticket_form_ids")
lcUpdated_at = loJResp.StringOf("brand.updated_at")
lcBrandUrl = loJResp.StringOf("brand.url")
i = 0
lnCount_i = loJResp.SizeOfArray("brand.logo.thumbnails")
do while i < lnCount_i
loJResp.I = i
lcContent_type = loJResp.StringOf("brand.logo.thumbnails[i].content_type")
lcContent_url = loJResp.StringOf("brand.logo.thumbnails[i].content_url")
lcDeleted = loJResp.StringOf("brand.logo.thumbnails[i].deleted")
lcFile_name = loJResp.StringOf("brand.logo.thumbnails[i].file_name")
lcHeight = loJResp.StringOf("brand.logo.thumbnails[i].height")
lcId = loJResp.StringOf("brand.logo.thumbnails[i].id")
lcInline = loJResp.StringOf("brand.logo.thumbnails[i].inline")
lcMalware_access_override = loJResp.StringOf("brand.logo.thumbnails[i].malware_access_override")
lcMalware_scan_result = loJResp.StringOf("brand.logo.thumbnails[i].malware_scan_result")
lcMapped_content_url = loJResp.StringOf("brand.logo.thumbnails[i].mapped_content_url")
lcSize = loJResp.StringOf("brand.logo.thumbnails[i].size")
lcUrl = loJResp.StringOf("brand.logo.thumbnails[i].url")
lcWidth = loJResp.StringOf("brand.logo.thumbnails[i].width")
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
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}"
}
]
}
