Show Brand

Show a Brand

GET/api/v2/brands/{brand_id}

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the Show Brand action (under Brands).
Fill in the fields below, then reference the result from later steps as {{showBrand.response.data}}.

Request

Path parameters

brand_idinteger (int64)required

The ID of the brand

Response

Returns 200 with an object. Read it in later steps with {{showBrand.response.data.<field>}}.

brandobject

activeboolean

If the brand is set as active

brand_urlstring

The url of the brand

created_atstring (date-time)

The time the brand was created

defaultboolean

Is the brand the default brand for this account

has_help_centerboolean

If the brand has a Help Center

help_center_statestring

The state of the Help Center

One ofenableddisabledrestricted

host_mappingstring

The hostmapping to this brand, if any. Only admins view this property.

idinteger (int64)

The ID automatically assigned when the brand is created

is_deletedboolean

If the brand object is deleted or not

logoobject

A file represented as an [Attachment](/api-reference/ticketing/tickets/ticket-attachments/) object

namestringrequired

The name of the brand

signature_templatestring

The signature template for a brand

subdomainstringrequired

The subdomain of the brand

ticket_form_idsarray<integer (int64)>

The ids of ticket forms that are available for use by a brand

updated_atstring (date-time)

The time of the last update of the brand

urlstring

The API url of this brand

user_separationstring

The user separation scope for the brand. When set to "brand", users created on this brand are isolated to it. When set to "account", users are shared across all account-scoped brands.

One ofaccountbrand

json

{
  "brand": {
    "active": true,
    "brand_url": "https://brand1.com",
    "created_at": "2012-04-02T22:55:29Z",
    "default": true,
    "has_help_center": true,
    "help_center_state": "enabled",
    "host_mapping": "brand1.com",
    "id": 47,
    "logo": {
      "content_type": "image/png",
      "content_url": "https://company.zendesk.com/logos/brand1_logo.png",
      "file_name": "brand1_logo.png",
      "id": 928374,
      "size": 166144,
      "thumbnails": [
        {
          "content_type": "image/png",
          "content_url": "https://company.zendesk.com/photos/brand1_logo_thumb.png",
          "file_name": "brand1_logo_thumb.png",
          "id": 928375,
          "mapped_content_url": "https://company.com/photos/brand1_logo_thumb.png",
          "size": 58298,
          "url": "https://company.zendesk.com/api/v2/attachments/928375"
        },
        {
          "content_type": "image/png",
          "content_url": "https://company.zendesk.com/photos/brand1_logo_small.png",
          "file_name": "brand1_logo_small.png",
          "id": 928376,
          "mapped_content_url": "https://company.com/photos/brand1_logo_small.png",
          "size": 58298,
          "url": "https://company.zendesk.com/api/v2/attachments/928376"
        }
      ],
      "url": "https://company.zendesk.com/api/v2/attachments/928374"
    },
    "name": "Brand 1",
    "signature_template": "{{agent.signature}}",
    "subdomain": "brand1",
    "ticket_form_ids": [
      47,
      33,
      22
    ],
    "updated_at": "2012-04-02T22:55:29Z",
    "url": "https://company.zendesk.com/api/v2/brands/47"
  }
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?