---
title: "Create Brand"
method: POST
path: "/api/v2/brands"
tags: ["Brands"]
---

# Create Brand

`POST /api/v2/brands`

#### Allowed for
- Admins

## Request body

- BrandCreateRequest
  - `brand` BrandObject
    - `active` boolean — If the brand is set as active
    - `brand_url` string — The url of the brand
    - `created_at` string, date-time — The time the brand was created
    - `default` boolean — Is the brand the default brand for this account
    - `has_help_center` boolean — If the brand has a Help Center
    - `help_center_state` 'enabled' | 'disabled' | 'restricted' — The state of the Help Center
    - `host_mapping` string — The hostmapping to this brand, if any. Only admins view this property.
    - `id` integer — The ID automatically assigned when the brand is created
    - `is_deleted` boolean — If the brand object is deleted or not
    - `logo` AttachmentObject — A file represented as an [Attachment](/api-reference/ticketing/tickets/ticket-attachments/) object
      - `content_type` string — The content type of the image. Example value: "image/png"
      - `content_url` string — 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](/documentation/ticketing/managing-tickets/working-with-url-properties)
      - `deleted` boolean — If true, the attachment has been deleted
      - `file_name` string — The name of the image file
      - `height` integer — The height of the image file in pixels. If height is unknown, returns null
      - `id` integer — Automatically assigned when created
      - `inline` boolean — 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
      - `malware_access_override` boolean — If true, you can download an attachment flagged as malware. If false, you can't download such an attachment.
      - `malware_scan_result` string — 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"
      - `mapped_content_url` string — The URL the attachment image file has been mapped to
      - `size` integer — The size of the image file in bytes
      - `url` string — A URL to access the attachment details
      - `width` integer — The width of the image file in pixels. If width is unknown, returns null
      - `thumbnails` AttachmentBaseObject[] — An array of attachment objects. Note that photo thumbnails do not have thumbnails
        - `content_type` string — The content type of the image. Example value: "image/png"
        - `content_url` string — 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](/documentation/ticketing/managing-tickets/working-with-url-properties)
        - `deleted` boolean — If true, the attachment has been deleted
        - `file_name` string — The name of the image file
        - `height` integer — The height of the image file in pixels. If height is unknown, returns null
        - `id` integer — Automatically assigned when created
        - `inline` boolean — 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
        - `malware_access_override` boolean — If true, you can download an attachment flagged as malware. If false, you can't download such an attachment.
        - `malware_scan_result` string — 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"
        - `mapped_content_url` string — The URL the attachment image file has been mapped to
        - `size` integer — The size of the image file in bytes
        - `url` string — A URL to access the attachment details
        - `width` integer — The width of the image file in pixels. If width is unknown, returns null
    - `name` string, required — The name of the brand
    - `signature_template` string — The signature template for a brand
    - `subdomain` string, required — The subdomain of the brand
    - `ticket_form_ids` integer[] — The ids of ticket forms that are available for use by a brand
    - `updated_at` string, date-time — The time of the last update of the brand
    - `url` string — The API url of this brand

## Response `201`

Successful response

- BrandResponse
  - `brand` BrandObject
    - `active` boolean — If the brand is set as active
    - `brand_url` string — The url of the brand
    - `created_at` string, date-time — The time the brand was created
    - `default` boolean — Is the brand the default brand for this account
    - `has_help_center` boolean — If the brand has a Help Center
    - `help_center_state` 'enabled' | 'disabled' | 'restricted' — The state of the Help Center
    - `host_mapping` string — The hostmapping to this brand, if any. Only admins view this property.
    - `id` integer — The ID automatically assigned when the brand is created
    - `is_deleted` boolean — If the brand object is deleted or not
    - `logo` AttachmentObject — A file represented as an [Attachment](/api-reference/ticketing/tickets/ticket-attachments/) object
      - `content_type` string — The content type of the image. Example value: "image/png"
      - `content_url` string — 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](/documentation/ticketing/managing-tickets/working-with-url-properties)
      - `deleted` boolean — If true, the attachment has been deleted
      - `file_name` string — The name of the image file
      - `height` integer — The height of the image file in pixels. If height is unknown, returns null
      - `id` integer — Automatically assigned when created
      - `inline` boolean — 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
      - `malware_access_override` boolean — If true, you can download an attachment flagged as malware. If false, you can't download such an attachment.
      - `malware_scan_result` string — 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"
      - `mapped_content_url` string — The URL the attachment image file has been mapped to
      - `size` integer — The size of the image file in bytes
      - `url` string — A URL to access the attachment details
      - `width` integer — The width of the image file in pixels. If width is unknown, returns null
      - `thumbnails` AttachmentBaseObject[] — An array of attachment objects. Note that photo thumbnails do not have thumbnails
        - `content_type` string — The content type of the image. Example value: "image/png"
        - `content_url` string — 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](/documentation/ticketing/managing-tickets/working-with-url-properties)
        - `deleted` boolean — If true, the attachment has been deleted
        - `file_name` string — The name of the image file
        - `height` integer — The height of the image file in pixels. If height is unknown, returns null
        - `id` integer — Automatically assigned when created
        - `inline` boolean — 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
        - `malware_access_override` boolean — If true, you can download an attachment flagged as malware. If false, you can't download such an attachment.
        - `malware_scan_result` string — 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"
        - `mapped_content_url` string — The URL the attachment image file has been mapped to
        - `size` integer — The size of the image file in bytes
        - `url` string — A URL to access the attachment details
        - `width` integer — The width of the image file in pixels. If width is unknown, returns null
    - `name` string, required — The name of the brand
    - `signature_template` string — The signature template for a brand
    - `subdomain` string, required — The subdomain of the brand
    - `ticket_form_ids` integer[] — The ids of ticket forms that are available for use by a brand
    - `updated_at` string, date-time — The time of the last update of the brand
    - `url` string — The API url of this brand

## Changes

> 29 revisions in range; 1 not diffed, 1 could not be searched.

- **2025-06-13** `4085d8c72c5c` — 4 breaking
  - the `brand/logo/allOf[#/components/schemas/AttachmentBaseObject]/height` response's property type/format changed from `string`/`` to `integer`/`` for status `201`
  - the `brand/logo/allOf[#/components/schemas/AttachmentBaseObject]/width` response's property type/format changed from `string`/`` to `integer`/`` for status `201`
  - the `brand/logo/allOf[#/components/schemas/AttachmentThumbnails]/thumbnails/items/height` response's property type/format changed from `string`/`` to `integer`/`` for status `201`
  - the `brand/logo/allOf[#/components/schemas/AttachmentThumbnails]/thumbnails/items/width` response's property type/format changed from `string`/`` to `integer`/`` for status `201`
- …earlier changes not shown

[Full history](https://skmtc.dev/botbrains-io/apis/support-api/changes/api/v2/brands/post.md)

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)