Skip to main content
PATCH
Update account

Authorizations

Authorization
string
header
required

API token obtained from the login endpoint or the dashboard

Path Parameters

id
string
required

ID of the resource

Body

application/json

Account settings to update

account
object
required

Response

Updated account

id
string
read-only

Unique identifier for the account

name
string
read-only

Domain of the account

account_type
enum<string>
read-only
Available options:
website,
mobile_app
domain
string | null
subdomain
string | null
default_language
string

ISO 639-1 code the banner falls back to

auto_translate
boolean
translations
string[]

ISO 639-1 codes the banner is translated into

industry
string | null
description
string | null
support_email
string | null
banner_debug_mode
boolean
blocking_mode
string | null

Years consent records are retained

allowed_domains
string[]
read-only

List of allowed domains the script will run on

owner_id
string
read-only

ID of the account user that owns the account

onboarding_status
string | null
read-only

The status of the account, where:

  • account_created: The account has been created.
  • vendors_setup: Categories, services or TCF vendors have been set up.
  • script_installed: The script has been installed on the user's website.
  • live: The account is live and operational.

null means the status could not be determined — the analytics store behind it was unreachable when the response was built. It is not a statement about the account, and the request itself still succeeded. Treat it as "unknown" and retry rather than as a downgrade in status.

visitor_stats
object | null

Visitor analytics for the last 30 days, compared against the 30 days before that. null when the client passed ?visitor_stats=false.

created_at
string<date-time>
read-only

Date and time when the account was created

updated_at
string<date-time>
read-only

Date and time when the account was last updated