Skip to main content
PATCH
Update tracked domains/pages or the monthly credit limit

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Body

application/json
domains
string[]

Replacement list of the website domains you have installed the tracking tag on, 0 to 50 entries of 3 to 255 characters. You choose the values — there is no vocabulary endpoint; read the current list from GET /business/website-tracking (tracking.domains) and send it back with your edits, because the whole array replaces the stored list on every call and an omitted entry is dropped. Use the canonical form the app writes: a bare lower-case hostname with no scheme, path or port and with a leading www. removed, for example brightpay.com rather than https://www.brightpay.com/pricing. Entries are whitespace-trimmed by this API; case is preserved and duplicates are kept, so any other spelling is accepted and simply sits in the list unused. Entries do not combine into a query: this list records where the tag is installed and does not gate collection — visits are attributed by the puid inside the tag script, so editing or emptying this list neither starts nor stops tracking, only adding or removing the script from the page does.

Maximum array length: 50
Required string length: 3 - 255
trackedPages
string[]

Replacement list of the page labels you want reported separately, up to 200 entries of 1 to 2048 characters. These are free-text names you choose, not URL paths: the app writes short lower-case labels such as pricing, home or product, and the label is echoed back verbatim as page on each visitor row. There is no vocabulary endpoint; read the current list from GET /business/website-tracking (tracking.trackedPages) and send it back with your edits, because the whole array replaces the stored list on every call and an omitted entry is dropped. Entries are whitespace-trimmed by this API; case is preserved and duplicates are kept. Entries do not combine into a query: each names one page reported on its own, and a visitor row carries at most one label. A label only yields data once the matching per-page tag script is installed on that page (the label is embedded in that script's puid), so adding a name here on its own is accepted and reports nothing. Must be sent together with domains because both ride one internal write that always replaces the domain list.

Maximum array length: 200
Required string length: 1 - 2048
monthlyCreditLimit
integer | null

Cap on the credits spent deanonymising visitors in one billing period: any whole number of credits from 0 to 10000000, or null to remove the cap and fall back to the plan's own allowance. Not a vocabulary — every integer in range is a legal value. A cap above the credits on your active subscription is rejected with 422 CREDIT_LIMIT_EXCEEDS_PLAN; an account with no active subscription is not checked against a plan. The counter it caps (tracking.credits.used) resets at the start of each billing period on monthly plans, and every 30 days or on renewal on annual plans. 0 stops deanonymisation until the cap is raised.

Required range: 0 <= x <= 10000000

Response

Success

tracking
object
required