Update pixel

Update the specified pixel's title, status, params, custom fields, or the sites it runs on. Set status to active or inactive to activate or deactivate the pixel. Send allowed_origins or allow_any_origin to change where it runs; the sites are checked and saved first, so a refused site leaves the pixel unchanged. Name the target project in the request (a project_id field for writes, or a ?project_id= query parameter for reads).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Target project the pixel belongs to (org-key path).

string
required
string
string
enum

Activate or deactivate the pixel. Omit to leave it unchanged. A deactivated pixel stops collecting events until reactivated. For a pixel shared across multiple sites, deactivating stops collection for the entire pixel, not a single site; isolating one customer requires a separate pixel per customer (create one via /api/v2/pixel/create).

Allowed:
params
array of objects
params
custom_fields
array of objects
custom_fields
allowed_origins
array of strings | null

Replaces the sites the pixel runs on, with the same rules as create: domains or URLs, stored as lowercase hostnames, and a 400 naming any refused entry. Omit or send null to leave the sites unchanged; send [] to remove them all.

allowed_origins
boolean | null

Turns running on any site on or off. Omit or send null to leave it unchanged. Cannot be true in the same request as a non-empty allowed_origins.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json