Brands
Create, delete, update, and query Brands in Zendesk.
Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the component.SELECT * FROM Brands WHERE Id = '123'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.
Insert
The Name and Subdomain fields are required to insert. Allowed for admins.
INSERT INTO Brands (Name, Subdomain) VALUES ('Brand 1', 'brand1')
Update
You must specify the Id of the automation to update. Allowed for agents.
UPDATE Brands SET Name = 'Brand 2', Subdomain = 'brand2', HostMapping = 'brand2.com', Active = true WHERE Id = '123'
Delete
You must specify the Id of the automation to delete it. Allowed for agents.
DELETE FROM Brands WHERE Id = '123'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | False |
Automatically assigned when the brand is created. | |
| Name | String | False |
The name of the brand. | |
| CreatedAt | Datetime | False |
The time the brand was created. | |
| UpdatedAt | Datetime | False |
The time of the last update of the brand. | |
| BrandUrl | String | False |
The url of the brand. | |
| HasHelpCenter | Boolean | False |
If the brand has a Help Center. | |
| HelpCenterState | String | False |
The state of the Help Center: enabled, disabled, or restricted. | |
| Active | Boolean | False |
If the brand is set as active. | |
| Default | Boolean | False |
Is the brand the default brand for this account. | |
| LogoId | Long | False |
The id of logo image for this brand. | |
| LogoUrl | String | False |
The url of logo image for this brand. | |
| LogoFileName | String | False |
The name of logo image for this brand. | |
| LogoContentUrl | String | False |
The content url of logo image for this brand. | |
| LogoMappedContentUrl | String | False |
The mapped content url of logo image for this brand. | |
| LogoContentType | String | False |
The content type of logo image for this brand. | |
| LogoSize | Integer | False |
The size of logo image for this brand. | |
| TicketFormIds | String | False |
The ids of ticket forms that are available for use by a brand. | |
| HostMapping | String | False |
The hostmapping to this brand, if any (only admins view this key). | |
| Subdomain | String | False |
The subdomain of the brand. | |
| SignatureTemplate | String | False |
The signature template for a brand. | |
| Url | String | False |
The API url of this brand. |