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.

Path Parameters

id
string<uuid>
required

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