---
title: "Enable web pixel"
description: "Turn on the STOQ web pixel, the dashboard's \"Set up tracking\" button on the Products > Engagement view. It records storefront button impressions, clicks and add-to-carts for the back-in-stock and preorder engagement repo"
url: https://docs.stoqapp.com/v2-reference/account-web-pixel/enable-web-pixel/
api: "API v2 reference"
method: POST
path: "/account/web_pixel/enable"
---

# Enable web pixel

`POST https://app.stoqapp.com/api/v2/external/account/web_pixel/enable`

Turn on the STOQ web pixel, the dashboard's "Set up tracking" button on the Products > Engagement view. It records storefront button impressions, clicks and add-to-carts for the back-in-stock and preorder engagement reports.

**Note:** Registers the pixel with Shopify once; calling it again when it is on changes nothing and returns already_installed true. Engagement reads say whether it is on in pixel_active. Data starts from the moment it is on.

## Headers

- `Idempotency-Key` (string): A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with `Idempotent-Replayed: true`, without running again; the same key with a different method, path or body is refused (422 `idempotency_key_reused`); a retry while the first is still running gets 409 `idempotency_key_in_progress`. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Rate limit: this call costs 2 points ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl -X POST "https://app.stoqapp.com/api/v2/external/account/web_pixel/enable" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the updated resource.

## 202

Accepted: async/bulk work was queued. Poll the returned job.

```json
{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 409

Invalid lifecycle transition: read the message; don't retry blindly. Also returned while an earlier request with the same Idempotency-Key is still running.

```json
{
  "errors": [
    "Offer is already disabled"
  ],
  "code": "conflict",
  "details": [
    {
      "code": "conflict",
      "message": "Offer is already disabled",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```