Product response envelope

Current product endpoints return a resource envelope: data.object, data.brand_id, data.page, and nested data.data containing the dashboard data. Pagination fields for these endpoints are inside data.data. Unknown measurements remain null; verified zeros remain 0. Sensitive values are redacted.

Write scopes require beta enrollment. Draft and calendar edits do not publish content. External effects require the confirmation rules described below.

The change detail contains the change set (version, state, gates), items (before/after values), qa results for the current version, publications and verifications. A prepared or accepted change is not proof of a verified live change.

POST …/website/actions (website:write, external), operation website_action

The body is one of:

{
  "action": "publish",
  "change_sets": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "version": 3
    }
  ],
  "idempotency_key": "PERSISTED_OPERATION_KEY",
  "confirm": true
}

{
  "action": "publish",
  "change_sets": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "version": 3
    }
  ],
  "idempotency_key": "PERSISTED_OPERATION_KEY",
  "confirm": true
}

{
  "action": "publish",
  "change_sets": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "version": 3
    }
  ],
  "idempotency_key": "PERSISTED_OPERATION_KEY",
  "confirm": true
}

{
  "action": "publish",
  "change_sets": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "version": 3
    }
  ],
  "idempotency_key": "PERSISTED_OPERATION_KEY",
  "confirm": true
}

{
  "action": "recheck",
  "resource_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "confirm": true
}

{
  "action": "recheck",
  "resource_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "confirm": true
}

{
  "action": "recheck",
  "resource_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "confirm": true
}

{
  "action": "recheck",
  "resource_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "confirm": true
}

{
  "action": "undo",
  "change_set_id": "11111111-1111-4111-8111-111111111111",
  "hold_field": true,
  "confirm": true
}

{
  "action": "undo",
  "change_set_id": "11111111-1111-4111-8111-111111111111",
  "hold_field": true,
  "confirm": true
}

{
  "action": "undo",
  "change_set_id": "11111111-1111-4111-8111-111111111111",
  "hold_field": true,
  "confirm": true
}

{
  "action": "undo",
  "change_set_id": "11111111-1111-4111-8111-111111111111",
  "hold_field": true,
  "confirm": true
}

{
  "action": "set_mode",
  "mode": "review",
  "confirm": true
}

{
  "action": "set_mode",
  "mode": "review",
  "confirm": true
}

{
  "action": "set_mode",
  "mode": "review",
  "confirm": true
}

{
  "action": "set_mode",
  "mode": "review",
  "confirm": true
}

For set_mode, choose review, autopilot, or paused.

Arrays have 1–50 items. Every supplied ID must belong to this brand (404). publish, recheck and set_mode (review/autopilot) require api.publishing.enabled and an active subscription. undo and set_mode: paused are recovery actions that work without them. Costs: see limits and credits. publish replays by idempotency_key. The action is forwarded to the website-api Edge Function, which applies the existing QA, version, entitlement and verification gates. Work is asynchronous, so poll the Website changes.