autoit / 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.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.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>"
; }
; }
$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("brand.name","<string>")
$oJson.UpdateString("brand.subdomain","<string>")
$oJson.UpdateString("brand.active","<boolean>")
$oJson.UpdateString("brand.brand_url","<string>")
$oJson.UpdateString("brand.created_at","<dateTime>")
$oJson.UpdateString("brand.default","<boolean>")
$oJson.UpdateString("brand.has_help_center","<boolean>")
$oJson.UpdateString("brand.help_center_state","enabled")
$oJson.UpdateString("brand.host_mapping","<string>")
$oJson.UpdateString("brand.id","<integer>")
$oJson.UpdateString("brand.is_deleted","<boolean>")
$oJson.UpdateString("brand.logo.content_type","<string>")
$oJson.UpdateString("brand.logo.content_url","<string>")
$oJson.UpdateString("brand.logo.deleted","<boolean>")
$oJson.UpdateString("brand.logo.file_name","<string>")
$oJson.UpdateString("brand.logo.height","<string>")
$oJson.UpdateString("brand.logo.id","<integer>")
$oJson.UpdateString("brand.logo.inline","<boolean>")
$oJson.UpdateString("brand.logo.malware_access_override","<boolean>")
$oJson.UpdateString("brand.logo.malware_scan_result","<string>")
$oJson.UpdateString("brand.logo.mapped_content_url","<string>")
$oJson.UpdateString("brand.logo.size","<integer>")
$oJson.UpdateString("brand.logo.url","<string>")
$oJson.UpdateString("brand.logo.width","<string>")
$oJson.UpdateString("brand.logo.thumbnails[0].content_type","<string>")
$oJson.UpdateString("brand.logo.thumbnails[0].content_url","<string>")
$oJson.UpdateString("brand.logo.thumbnails[0].deleted","<boolean>")
$oJson.UpdateString("brand.logo.thumbnails[0].file_name","<string>")
$oJson.UpdateString("brand.logo.thumbnails[0].height","<string>")
$oJson.UpdateString("brand.logo.thumbnails[0].id","<integer>")
$oJson.UpdateString("brand.logo.thumbnails[0].inline","<boolean>")
$oJson.UpdateString("brand.logo.thumbnails[0].malware_access_override","<boolean>")
$oJson.UpdateString("brand.logo.thumbnails[0].malware_scan_result","<string>")
$oJson.UpdateString("brand.logo.thumbnails[0].mapped_content_url","<string>")
$oJson.UpdateString("brand.logo.thumbnails[0].size","<integer>")
$oJson.UpdateString("brand.logo.thumbnails[0].url","<string>")
$oJson.UpdateString("brand.logo.thumbnails[0].width","<string>")
$oJson.UpdateString("brand.logo.thumbnails[1].content_type","<string>")
$oJson.UpdateString("brand.logo.thumbnails[1].content_url","<string>")
$oJson.UpdateString("brand.logo.thumbnails[1].deleted","<boolean>")
$oJson.UpdateString("brand.logo.thumbnails[1].file_name","<string>")
$oJson.UpdateString("brand.logo.thumbnails[1].height","<string>")
$oJson.UpdateString("brand.logo.thumbnails[1].id","<integer>")
$oJson.UpdateString("brand.logo.thumbnails[1].inline","<boolean>")
$oJson.UpdateString("brand.logo.thumbnails[1].malware_access_override","<boolean>")
$oJson.UpdateString("brand.logo.thumbnails[1].malware_scan_result","<string>")
$oJson.UpdateString("brand.logo.thumbnails[1].mapped_content_url","<string>")
$oJson.UpdateString("brand.logo.thumbnails[1].size","<integer>")
$oJson.UpdateString("brand.logo.thumbnails[1].url","<string>")
$oJson.UpdateString("brand.logo.thumbnails[1].width","<string>")
$oJson.UpdateString("brand.signature_template","<string>")
$oJson.UpdateString("brand.ticket_form_ids","<array>")
$oJson.UpdateString("brand.updated_at","<dateTime>")
$oJson.UpdateString("brand.url","<string>")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbRequestBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/brands/:brand_id",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sContent_type
Local $sContent_url
Local $sDeleted
Local $sFile_name
Local $sHeight
Local $sId
Local $sInline
Local $sMalware_access_override
Local $sMalware_scan_result
Local $sMapped_content_url
Local $size
Local $sUrl
Local $sWidth
Local $sName = $oJResp.StringOf("brand.name")
Local $sSubdomain = $oJResp.StringOf("brand.subdomain")
Local $sActive = $oJResp.StringOf("brand.active")
Local $sBrand_url = $oJResp.StringOf("brand.brand_url")
Local $sCreated_at = $oJResp.StringOf("brand.created_at")
Local $sDefault = $oJResp.StringOf("brand.default")
Local $sHas_help_center = $oJResp.StringOf("brand.has_help_center")
Local $sHelp_center_state = $oJResp.StringOf("brand.help_center_state")
Local $sHost_mapping = $oJResp.StringOf("brand.host_mapping")
Local $sId = $oJResp.StringOf("brand.id")
Local $sIs_deleted = $oJResp.StringOf("brand.is_deleted")
Local $sContent_type = $oJResp.StringOf("brand.logo.content_type")
Local $sContent_url = $oJResp.StringOf("brand.logo.content_url")
Local $sDeleted = $oJResp.StringOf("brand.logo.deleted")
Local $sFile_name = $oJResp.StringOf("brand.logo.file_name")
Local $sHeight = $oJResp.StringOf("brand.logo.height")
Local $sLogoId = $oJResp.StringOf("brand.logo.id")
Local $sInline = $oJResp.StringOf("brand.logo.inline")
Local $sMalware_access_override = $oJResp.StringOf("brand.logo.malware_access_override")
Local $sMalware_scan_result = $oJResp.StringOf("brand.logo.malware_scan_result")
Local $sMapped_content_url = $oJResp.StringOf("brand.logo.mapped_content_url")
Local $sSize = $oJResp.StringOf("brand.logo.size")
Local $sV_Url = $oJResp.StringOf("brand.logo.url")
Local $sWidth = $oJResp.StringOf("brand.logo.width")
Local $sSignature_template = $oJResp.StringOf("brand.signature_template")
Local $sTicket_form_ids = $oJResp.StringOf("brand.ticket_form_ids")
Local $sUpdated_at = $oJResp.StringOf("brand.updated_at")
Local $sBrandUrl = $oJResp.StringOf("brand.url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("brand.logo.thumbnails")
While $i < $iCount_i
$oJResp.I = $i
$sContent_type = $oJResp.StringOf("brand.logo.thumbnails[i].content_type")
$sContent_url = $oJResp.StringOf("brand.logo.thumbnails[i].content_url")
$sDeleted = $oJResp.StringOf("brand.logo.thumbnails[i].deleted")
$sFile_name = $oJResp.StringOf("brand.logo.thumbnails[i].file_name")
$sHeight = $oJResp.StringOf("brand.logo.thumbnails[i].height")
$sId = $oJResp.StringOf("brand.logo.thumbnails[i].id")
$sInline = $oJResp.StringOf("brand.logo.thumbnails[i].inline")
$sMalware_access_override = $oJResp.StringOf("brand.logo.thumbnails[i].malware_access_override")
$sMalware_scan_result = $oJResp.StringOf("brand.logo.thumbnails[i].malware_scan_result")
$sMapped_content_url = $oJResp.StringOf("brand.logo.thumbnails[i].mapped_content_url")
$size = $oJResp.StringOf("brand.logo.thumbnails[i].size")
$sUrl = $oJResp.StringOf("brand.logo.thumbnails[i].url")
$sWidth = $oJResp.StringOf("brand.logo.thumbnails[i].width")
$i = $i + 1
Wend
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}"
}
]
}
