Skip to content

Skip the setup guide

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

POST/account/setup_guide/skip

Costs 2 rate-limit points · Rate limits

Skip the Home page setup guide, as its Skip setup button does: the guide is marked done and hidden for good. flow is back_in_stock or preorders; leave it out to skip both.

Cannot be undone, as in the dashboard. Returns the setup guide.

Also searched asskip setup guideskip onboardinghide setup guidehide getting started

Headers

  • Idempotency-Keystring

    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.

Request body

  • flowstring

    The guide to skip: back_in_stock or preorders. Leave out to skip both.

    One of back_in_stockpreorders

Returns

  • back_in_stockobject
    Show 7 child attributesHide child attributes
    • chosenboolean
      Example: true
    • completed_atstring
    • stepsarray of objects
      Show 2 child attributesHide child attributes
      • stepstring
        Example: app_embed
      • doneboolean
        Example: true
    • steps_doneinteger
      Example: 3
    • next_stepnull
      Example: first_alert_sent
    • shown_on_homeboolean
      Example: true
    • first_signup_idnull
      Example: 5b8e2c41-7d3a-4f6e-9a12-3c4d5e6f7a8b
  • preordersobject
    Show 6 child attributesHide child attributes
    • chosenboolean
      Example: true
    • completed_atstring, nullable
      Example: 2026-11-13T15:30:00Z
    • stepsarray of objects
      Show 2 child attributesHide child attributes
      • stepstring
        Example: app_embed
      • doneboolean
        Example: true
    • steps_doneinteger
      Example: 4
    • next_stepstring, nullable
    • shown_on_homeboolean
      Example: true

Errors

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

POST/account/setup_guide/skip
curl -X POST "https://app.stoqapp.com/api/v2/external/account/setup_guide/skip" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "preorders"
  }'
Response
{
  "back_in_stock": {
    "chosen": true,
    "completed_at": null,
    "steps": [
      {
        "step": "app_embed",
        "done": true
      },
      {
        "step": "design_widget",
        "done": true
      },
      {
        "step": "first_signup",
        "done": true
      },
      {
        "step": "first_alert_sent",
        "done": false
      }
    ],
    "steps_done": 3,
    "next_step": "first_alert_sent",
    "shown_on_home": true,
    "first_signup_id": "5b8e2c41-7d3a-4f6e-9a12-3c4d5e6f7a8b"
  },
  "preorders": {
    "chosen": true,
    "completed_at": "2026-11-13T15:30:00Z",
    "steps": [
      {
        "step": "app_embed",
        "done": true
      },
      {
        "step": "first_offer",
        "done": true
      },
      {
        "step": "first_product",
        "done": false
      },
      {
        "step": "first_order",
        "done": false
      }
    ],
    "steps_done": 4,
    "next_step": null,
    "shown_on_home": true
  }
}