Check Host Mapping Validity

GET {{baseUrl}}/api/v2/brands/check_host_mapping?host_mapping=<string>&subdomain=<string>

Returns a JSON object determining whether a host mapping is valid for a given subdomain.

Allowed for

  • Admins

Request Params

KeyDatatypeRequiredDescription
host_mappingstring(Required) The hostmapping to a brand, if any (only admins view this key)
subdomainstring(Required) Subdomain for a given Zendesk account address

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;cname&quot;:&quot;bar.zendesk.com&quot;,&quot;is_valid&quot;:true}