Check Host Mapping Validity

GET/api/v2/brands/check_host_mapping

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the Check Host Mapping Validity action (under Brands).
Fill in the fields below, then reference the result from later steps as {{checkHostMappingValidity.response.data}}.

host_mappingstringrequired

The hostmapping to a brand, if any (only admins view this key)

subdomainstringrequired

Subdomain for a given Zendesk account address

Returns 200 with an object. Read it in later steps with {{checkHostMappingValidity.response.data.<field>}}.

cnamestring

The canonical name record for a host mapping

expected_cnamesarray<string>

Array of expected CNAME records for host mapping(s) of a given brand

is_validboolean

Whether a host mapping is valid or not for a given brand

reasonstring

Reason why a host mapping is valid or not

json

{
  "cname": "string",
  "expected_cnames": [
    "string"
  ],
  "is_valid": false,
  "reason": "string"
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?