Create pixel (v1)

Deprecated. Use Create pixel (v2), which requires you to declare where the pixel runs. This version keeps working until Sat, 24 Apr 2027 00:00:00 GMT, and every response carries Deprecation, Sunset and Link headers that say so.

Create a new tracking pixel. Simple mode: pass only a title (defaults applied). Detailed mode: include params and custom_fields for full control. allowed_origins and allow_any_origin are optional here. Without either, the pixel is created with no declared sites and origins_status is unverified. Name the target project with a project_id field.

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
params
array of objects
params
custom_fields
array of objects
custom_fields
allowed_origins
array of strings
length ≤ 500

The sites the pixel runs on, as domains or URLs, such as example.com or https://shop.example.com. Each entry is stored as its lowercase hostname, and repeats are dropped. IP addresses, localhost, a name with no dot, a bare public suffix such as co.uk, and wildcards are refused with a 400 that names the entry.

allowed_origins
boolean

Set to true when the pixel runs on any site, for example one pixel installed across many client sites.

Responses

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