---
title: "Skip the setup guide"
description: "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."
url: https://docs.stoqapp.com/v2-reference/account-setup-guide/skip-the-setup-guide/
api: "API v2 reference"
method: POST
path: "/account/setup_guide/skip"
---

# Skip the setup guide

`POST https://app.stoqapp.com/api/v2/external/account/setup_guide/skip`

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.

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

## 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.

## Request body

- `flow` (string): The guide to skip: back_in_stock or preorders. Leave out to skip both. One of: `back_in_stock`, `preorders`.

## Returns

- `back_in_stock` (object)
  - `chosen` (boolean): e.g. `true`
  - `completed_at` (string)
  - `steps` (array of objects)
    - `step` (string): e.g. `app_embed`
    - `done` (boolean): e.g. `true`
  - `steps_done` (integer): e.g. `3`
  - `next_step` (null): e.g. `first_alert_sent`
  - `shown_on_home` (boolean): e.g. `true`
  - `first_signup_id` (null): e.g. `5b8e2c41-7d3a-4f6e-9a12-3c4d5e6f7a8b`
- `preorders` (object)
  - `chosen` (boolean): e.g. `true`
  - `completed_at` (string, nullable): e.g. `2026-11-13T15:30:00Z`
  - `steps` (array of objects)
    - `step` (string): e.g. `app_embed`
    - `done` (boolean): e.g. `true`
  - `steps_done` (integer): e.g. `4`
  - `next_step` (string, nullable)
  - `shown_on_home` (boolean): e.g. `true`

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/setup_guide/skip" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "preorders"
  }'
```

## 200

Success: example response shown.

```json
{
  "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
  }
}
```

## 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

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

```json
{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "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
    }
  ]
}
```

