Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zendesk Brands API

The Brands API from Zendesk — 4 operation(s) for brands.

Zendesk Brands API is one of 150 APIs that Zendesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Brands. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 7 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://{subdomain}.zendesk.com.

7 operations 4 paths 3 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{subdomain}.zendesk.com
Resource Areas
1

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Brands 7
GET
/api/v2/brands
Zendesk Get Api V2 Brands
ListBrands → 200
POST
/api/v2/brands
Zendesk Post Api V2 Brands
CreateBrand body → 201
GET
/api/v2/brands/{brand_id}
Zendesk Get Api V2 Brands Brandid
ShowBrand 1 param → 200
PUT
/api/v2/brands/{brand_id}
Zendesk Put Api V2 Brands Brandid
UpdateBrand 1 param body → 200
DELETE
/api/v2/brands/{brand_id}
Zendesk Delete Api V2 Brands Brandid
DeleteBrand 1 param → 204
GET
/api/v2/brands/{brand_id}/check_host_mapping
Zendesk Get Api V2 Brands Brandid Checkhostmapping
CheckHostMappingValidityForExistingBrand 1 param → 200
GET
/api/v2/brands/check_host_mapping
Zendesk Get Api V2 Brands Checkhostmapping
CheckHostMappingValidity 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are HostMappingObject (4 properties), BrandResponse (1 property). Each schema is shown below with its type and property counts.

HostMappingObject
object
4 properties
BrandResponse
object
1 property
BrandsResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-brands-api-openapi.yml Raw ↑

Other APIs Zendesk publishes across the network.

Zendesk Help Center Articles API
Zendesk Help Center Sections API
Zendesk Help Center Categories API
Zendesk Help Center Translations API
Zendesk Help Center Article Attachments API
Zendesk Help Center Article Comments API
Zendesk Help Center Article Labels API
Zendesk Help Center Topics API
Zendesk Help Center Posts API
Zendesk Help Center Post Comments API
Zendesk Help Center Votes API
Zendesk Help Center Content Subscriptions API