Skip to main content
POST
Register a partner domain

Authorizations

X-API-Key
string
header
required

Partner management key (pk_live_...) from Partner Dashboard. Server-side use only; not a visitor-data key.

Body

application/json
domain
string
required

Hostname only, without scheme or path.

clientRef
string

Optional attribution label for your customer.

groupId
string

Optional existing domain group in the same partner account.

Response

Existing domain attached or returned

success
boolean
existing
boolean
customerId
string

Your shared partner account identifier, used by every site's returned snippet.

domain
string
clientRef
string
groupId
string
status
string
pixelSnippet
string

Install this in the site's shared page template. It contains no management or data API key.

trackingSyncPending
boolean

Tracking is ready when the domain is active and this is false.