Enable

POST

/account/web_pixel/enable

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/account/web_pixel/enable \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

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.

Authorizations

• ApiKeyAuth

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

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

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

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

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

409

Invalid lifecycle transition — read the message; don’t retry blindly.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Offer is already disabled"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

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

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}