Sign in
Brands

Create Brand

Allowed for

  • Admins
post/api/v2/brands

Request body

Example request

{
  "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.json"
        },
        {
          "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.json"
        }
      ],
      "url": "https://company.zendesk.com/api/v2/attachments/928374.json"
    },
    "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.json"
  }
}

Response

Successful response

Example response

{
  "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.json"
        },
        {
          "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.json"
        }
      ],
      "url": "https://company.zendesk.com/api/v2/attachments/928374.json"
    },
    "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.json"
  }
}

Changes