Skip to main content
PATCH
/
v1
/
data
/
pixels
/
{id}
Update a pixel (pause, activate, or set path filters)
curl --request PATCH \
  --url https://api.aws53.cloud/v1/data/pixels/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "paused",
  "excludedPaths": [
    "/blog",
    "/careers"
  ],
  "includedPaths": [
    "/pricing",
    "/demo"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain": "<string>",
    "name": "<string>",
    "status": "<string>",
    "excludedPaths": [
      "<string>"
    ],
    "includedPaths": [
      "<string>"
    ],
    "updatedAt": "<string>"
  }
}

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:
["/blog", "/careers"]
​
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:
["/pricing", "/demo"]

Response

Pixel updated

​
data
object
required