Skip to main content
POST
Connect a customer-owned domain or subdomain for SSL termination.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Connect a customer-owned domain or subdomain for SSL termination and routing

Create a branded-domain connection for a domain or subdomain you already own. This uses one domain-connection slot; additional slots are available as a $5/month add-on. It does not purchase or register a domain.

companyId
string
required

Company that owns the connection slot

subdomain
string
required

Customer-owned domain or subdomain to connect, e.g. track.example.com. Do not include https://.

Response

Branded-domain connection and DNS A-record instructions

domain
object

Created branded-domain connection

dnsRecord
object

A record to create at the customer’s existing DNS host

approximatedRegistered
boolean

Whether SSL-routing provisioning was accepted

approximatedError
string

Provisioning warning, if any. The connection remains available for DNS setup.