Skip to main content
PATCH

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

A site already registered in this partner account.

action
enum<string>
required
Available options:
activate,
deactivate,
updateRef,
updatePaths
clientRef
string

With updateRef. The new attribution label; empty removes it.

allowedPaths
string[]

With updatePaths. Page rules to track; [] tracks the whole site.

Response

Site updated. Which fields are returned depends on the action.

success
boolean
domain
string
status
enum<string>

With activate and deactivate.

Available options:
active,
inactive
clientRef
string

With updateRef.

allowedPaths
string[]

With updatePaths. The rules now saved.

rejected
string[]

With updatePaths. Rules that were not saved.

trackingSyncPending
boolean

With activate and deactivate. True until the pixel has been updated.