Skip to main content
Custom domains are available through REST and MCP to API tokens, OAuth connections and the Operator. Chat and voice agents can’t use them. Every method also requires Portals access for the workspace.

​
Connect a domain

  1. Call Connect a domain with a hostname you own, such as stay.example.com. Leave out the scheme and path.
  2. Setup runs in the background. Read List domains for the dns_record and verification_records to add at your DNS provider.
  3. After adding the records, call Check a domain again. The domain’s status stays pending until setup finishes, then becomes active.
template_ids chooses which portal templates use the hostname. An empty list makes it the default hostname for templates without their own. Set confirmation_code_links to true to put the booking confirmation code in portal links on the hostname. Turning it off breaks links that already use a confirmation code.

​
Disconnect a domain

Disconnecting stops portal links on the hostname right away. New links use another connected hostname or the standard portal address. Removal finishes in the background, after which the domain leaves the list.