Skip the setup guide
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/setup_guide/skipCosts 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-KeystringA 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 (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
flowstringThe guide to skip: back_in_stock or preorders. Leave out to skip both.
One ofback_in_stockpreorders
Returns
back_in_stockobjectShow 7 child attributesHide child attributes
chosenbooleanExample:truecompleted_atstringstepsarray of objectsShow 2 child attributesHide child attributes
stepstringExample:app_embeddonebooleanExample:true
steps_doneintegerExample:3next_stepnullExample:first_alert_sentshown_on_homebooleanExample:truefirst_signup_idnullExample:5b8e2c41-7d3a-4f6e-9a12-3c4d5e6f7a8b
preordersobjectShow 6 child attributesHide child attributes
chosenbooleanExample:truecompleted_atstring, nullableExample:2026-11-13T15:30:00Zstepsarray of objectsShow 2 child attributesHide child attributes
stepstringExample:app_embeddonebooleanExample:true
steps_doneintegerExample:4next_stepstring, nullableshown_on_homebooleanExample:true
Errors
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe 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.
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"
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/account/setup_guide/skip", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"flow": "preorders"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/account/setup_guide/skip",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"flow": "preorders"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/account/setup_guide/skip")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
flow: "preorders"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"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
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}