Skip to main content
PATCH
Update a pixel (pause, activate, or set path filters)

Authorizations

X-API-Key
string
header
required

Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.

Headers

X-Whitelabel-Slug
string

Optional tenant context for admin-key operations without an organization target, such as creating an organization. Defaults to the master tenant. Must match an explicit target organization when both are supplied. Does not limit the key’s platform authority.

Required string length: 1 - 100
X-Organization-Id
string<uuid>

Target organization for admin-key requests on organization-context routes, including Data API, intent audiences and dashboard routes without an organization path parameter. Required on those routes. When supplied with an organization path parameter, both must identify the same organization; conflicting targets return 400. Does not grant access to customer credentials.

Path Parameters

id
string<uuid>
required

Pixel identifier belonging to the organization

Example:

"11111111-1111-4111-8111-111111111111"

Body

application/json
status
enum<string>
Available options:
active,
paused
Example:

"paused"

excludedPaths
string[] | null

Denylist: URL path prefixes where tracking is skipped. Mutually exclusive with includedPaths.

Maximum array length: 50
Required string length: 2 - 500
Pattern: ^\/
Example:
includedPaths
string[] | null

Allowlist: if set, tracking fires ONLY on matching path prefixes. Mutually exclusive with excludedPaths.

Maximum array length: 50
Required string length: 2 - 500
Pattern: ^\/
Example:

Response

Pixel updated

data
object
required