PUT /api/v2/brands/{brand_id}

Returns an updated brand.

Allowed for

Admins

Updating a Brand's Image

A brand image can be updated by uploading a local file using the update brand endpoint. See the Using curl sections below for more information.

Servers

https://{subdomain}.{domain}.com

Path parameters

Name	Type	Required	Description
`brand_id`	Integer	Yes	The ID of the brand

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`brand`	Object	No
`brand.signature_template`	String	No	The signature template for a brand
`brand.subdomain`	String	Yes	The subdomain of the brand
`brand.default`	Boolean	No	Is the brand the default brand for this account
`brand.url`	String	No	The API url of this brand
`brand.is_deleted`	Boolean	No	If the brand object is deleted or not
`brand.updated_at`	String	No	The time of the last update of the brand
`brand.id`	Integer	No	The ID automatically assigned when the brand is created
`brand.logo`	Object	No	A file represented as an Attachment object
`brand.logo.content_type`	String	No	The content type of the image. Example value: "image/png"
`brand.logo.inline`	Boolean	No	If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false
`brand.logo.size`	Integer	No	The size of the image file in bytes
`brand.logo.deleted`	Boolean	No	If true, the attachment has been deleted
`brand.logo.height`	String	No	The height of the image file in pixels. If height is unknown, returns null
`brand.logo.url`	String	No	A URL to access the attachment details
`brand.logo.width`	String	No	The width of the image file in pixels. If width is unknown, returns null
`brand.logo.thumbnails[]`	Array	No	An array of attachment objects. Note that photo thumbnails do not have thumbnails
`brand.logo.thumbnails[].content_type`	String	No	The content type of the image. Example value: "image/png"
`brand.logo.thumbnails[].inline`	Boolean	No	If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false
`brand.logo.thumbnails[].size`	Integer	No	The size of the image file in bytes
`brand.logo.thumbnails[].deleted`	Boolean	No	If true, the attachment has been deleted
`brand.logo.thumbnails[].height`	String	No	The height of the image file in pixels. If height is unknown, returns null
`brand.logo.thumbnails[].url`	String	No	A URL to access the attachment details
`brand.logo.thumbnails[].width`	String	No	The width of the image file in pixels. If width is unknown, returns null
`brand.logo.thumbnails[].malware_access_override`	Boolean	No	If true, you can download an attachment flagged as malware. If false, you can't download such an attachment.
`brand.logo.thumbnails[].mapped_content_url`	String	No	The URL the attachment image file has been mapped to
`brand.logo.thumbnails[].file_name`	String	No	The name of the image file
`brand.logo.thumbnails[].content_url`	String	No	A full URL where the attachment image file can be downloaded. The file may be hosted externally so take care not to inadvertently send Zendesk authentication credentials. See Working with url properties
`brand.logo.thumbnails[].id`	Integer	No	Automatically assigned when created
`brand.logo.thumbnails[].malware_scan_result`	String	No	The result of the malware scan. There is a delay between the time the attachment is uploaded and when the malware scan is completed. Usually the scan is done within a few seconds, but high load conditions can delay the scan results. Possible values: "malware_found", "malware_not_found", "failed_to_scan", "not_scanned"
`brand.logo.malware_access_override`	Boolean	No	If true, you can download an attachment flagged as malware. If false, you can't download such an attachment.
`brand.logo.mapped_content_url`	String	No	The URL the attachment image file has been mapped to
`brand.logo.file_name`	String	No	The name of the image file
`brand.logo.content_url`	String	No	A full URL where the attachment image file can be downloaded. The file may be hosted externally so take care not to inadvertently send Zendesk authentication credentials. See Working with url properties
`brand.logo.id`	Integer	No	Automatically assigned when created
`brand.logo.malware_scan_result`	String	No	The result of the malware scan. There is a delay between the time the attachment is uploaded and when the malware scan is completed. Usually the scan is done within a few seconds, but high load conditions can delay the scan results. Possible values: "malware_found", "malware_not_found", "failed_to_scan", "not_scanned"
`brand.ticket_form_ids[]`	Array	No	The ids of ticket forms that are available for use by a brand
`brand.help_center_state`	String	No	The state of the Help Center Possible values: `"disabled"` `"enabled"` `"restricted"`
`brand.name`	String	Yes	The name of the brand
`brand.active`	Boolean	No	If the brand is set as active
`brand.brand_url`	String	No	The url of the brand
`brand.created_at`	String	No	The time the brand was created
`brand.host_mapping`	String	No	The hostmapping to this brand, if any. Only admins view this property.
`brand.has_help_center`	Boolean	No	If the brand has a Help Center

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.