Get early access

Brands

Brands: 4 operations of the ChaosDesk REST API.

Retrieves the collection of Brand resources.

GET/api/brands

Responses

  • 200Brand collection
  • 403Forbidden

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/brands" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Creates a Brand resource.

POST/api/brands

Request body application/json

namestringrequired
subdomainstring
slugstringrequired
The brand's path in a unified help centre: /hc/{locale}/{slug}/… (e.g. /hc/en/enterprise/articles/…).
help_center_hoststring | null
Zendesk "host mapping": the brand's own help-centre domain (e.g. help.example.com). Without one the help centre lives at {subdomain}.{HC_BASE_DOMAIN} (see App\HelpCenter\HelpCenterHosts).
is_defaultboolean
activeboolean
signature_templatestring | null
Twig (sandboxed) appended to outbound agent replies.
personalized_repliesboolean
Zendesk "personalized email replies": the From name carries the replying agent's name.
from_name_format"agent_address" | "agent_via_brand"
agent_address = "Ana Silva (Acme Support)" (Zendesk), agent_via_brand = "Ana Silva via Acme".
email_template"modern" | "plain"
modern | plain (Zendesk modern_email_template).
email_accent_colorstring | null
email_footerstring | null
Plain text shown at the bottom of every email of this brand (address, legal line…).

Responses

  • 201Brand resource created
  • 400Invalid input
  • 403Forbidden
  • 422An error occurred

Example request

curl -X POST "https://yourcompany.chaosdesk.io/api/brands" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string"}'

Retrieves a Brand resource.

GET/api/brands/{id}

Parameters

idstringpathrequired
Brand identifier

Responses

  • 200Brand resource
  • 403Forbidden
  • 404Not found

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/brands/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Updates the Brand resource.

PATCH/api/brands/{id}

Parameters

idstringpathrequired
Brand identifier

Request body application/merge-patch+json

namestring
subdomainstring
slugstring
The brand's path in a unified help centre: /hc/{locale}/{slug}/… (e.g. /hc/en/enterprise/articles/…).
help_center_hoststring | null
Zendesk "host mapping": the brand's own help-centre domain (e.g. help.example.com). Without one the help centre lives at {subdomain}.{HC_BASE_DOMAIN} (see App\HelpCenter\HelpCenterHosts).
is_defaultboolean
activeboolean
signature_templatestring | null
Twig (sandboxed) appended to outbound agent replies.
personalized_repliesboolean
Zendesk "personalized email replies": the From name carries the replying agent's name.
from_name_format"agent_address" | "agent_via_brand"
agent_address = "Ana Silva (Acme Support)" (Zendesk), agent_via_brand = "Ana Silva via Acme".
email_template"modern" | "plain"
modern | plain (Zendesk modern_email_template).
email_accent_colorstring | null
email_footerstring | null
Plain text shown at the bottom of every email of this brand (address, legal line…).

Responses

  • 200Brand resource updated
  • 400Invalid input
  • 403Forbidden
  • 404Not found
  • 422An error occurred

Example request

curl -X PATCH "https://yourcompany.chaosdesk.io/api/brands/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"name":"string","subdomain":"string"}'