Brands

Returns brands, including name, subdomain, Help Center state, and logo details.

Table-Specific Information

Select

The following query is processed server-side while other filters are processed client-side within the provider.

SELECT * FROM Brands WHERE Id = '123'

Insert

The Name and Subdomain columns are required to insert. This operation is allowed for logged-in users with the "admins" role.

INSERT INTO Brands (Name, Subdomain) VALUES ('Brand 1', 'brand1')

Update

You must specify the Id of the brand to update it. This operation is allowed for logged-in users with the "agents" role.

UPDATE Brands SET Name = 'Brand 2', Subdomain = 'brand2', HostMapping = 'brand2.com', Active = true  WHERE Id = '123'

Delete

You must specify the Id of the brand to delete it. This operation is allowed for logged-in users with the "agents" role.

DELETE FROM Brands WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		The Id automatically assigned when the brand is created.
Name	String	False		The name of the brand.
CreatedAt	Datetime	False		The date and time when the brand was created.
UpdatedAt	Datetime	False		The date and time when the brand was last updated.
BrandUrl	String	False		The URL of the brand.
HasHelpCenter	Boolean	False		Indicates whether the brand has a Help Center.
HelpCenterState	String	False		The state of the Help Center: enabled, disabled, or restricted.
Active	Boolean	False		Indicates whether the brand is active.
Default	Boolean	False		Indicates whether the brand is the default brand for this account.
LogoId	Long	False		The Id of the logo image for this brand.
LogoUrl	String	False		The URL of the logo image for this brand.
LogoFileName	String	False		The name of the logo image for this brand.
LogoContentUrl	String	False		The content URL of the logo image for this brand.
LogoMappedContentUrl	String	False		The mapped content URL of the logo image for this brand.
LogoContentType	String	False		The content type of the logo image for this brand.
LogoSize	Integer	False		The size of the 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.
Deleted	Boolean	False		True if the brand was previously deleted. Deleted brands only show when their ID is specified in the where clause.