---
title: "Dismiss setup checklist"
description: "Hide the getting-started checklist on the dashboard home for good. Idempotent. Returns the setup section."
url: https://docs.invoicefalcon.com/v3-reference/account/dismiss-setup-checklist/
api: "API v3 reference"
method: POST
path: "/account/setup/dismiss"
---

# Dismiss setup checklist

`POST https://app.invoicefalcon.com/api/v3/external/account/setup/dismiss`

Hide the getting-started checklist on the dashboard home for good. Idempotent. Returns the setup section.

**Note:** The checklist does not come back; its steps are still reported by [`GET /account/setup`](https://docs.invoicefalcon.com/v3-reference/account/retrieve-setup-settings/).

## Returns

- `store` (object)
  - `name` (string): e.g. `Invoice Static Store`
  - `domain` (string): e.g. `invoice-falcon-static-test-store.myshopify.com`
  - `email` (string): e.g. `nexasky@gmail.com`
  - `country_code` (string): e.g. `IN`
  - `currency` (string): e.g. `INR`
  - `timezone` (string): e.g. `America/New_York`
- `plan_name` (string): e.g. `ultimate`
- `installed_at` (string): e.g. `2026-11-10T08:35:15Z`
- `onboarded` (boolean): e.g. `false`
- `onboarded_at` (string, nullable)
- `interface` (string): e.g. `v3`
- `migrated_from` (string, nullable)
- `checklist` (object)
  - `dismissed` (boolean): e.g. `true`
  - `steps` (object)
    - `template_design` (boolean): e.g. `false`
    - `visual_editor` (boolean): e.g. `false`
    - `first_document` (boolean): e.g. `false`
    - `automatic_invoicing` (boolean): e.g. `false`
  - `completed_count` (integer): e.g. `0`
  - `total` (integer): e.g. `4`
  - `visual_editor_template_id` (integer, nullable)

Rate limit: this call costs 2 points ([rate limits](https://docs.invoicefalcon.com/v3/docs/api-v3/rate-limits/)).

## Example request

```sh
curl -X POST "https://app.invoicefalcon.com/api/v3/external/account/setup/dismiss" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
```

## 200

The updated resource.

```json
{
  "store": {
    "name": "Invoice Static Store",
    "domain": "invoice-falcon-static-test-store.myshopify.com",
    "email": "nexasky@gmail.com",
    "country_code": "IN",
    "currency": "INR",
    "timezone": "America/New_York"
  },
  "plan_name": "ultimate",
  "installed_at": "2026-11-10T08:35:15Z",
  "onboarded": false,
  "onboarded_at": null,
  "interface": "v3",
  "migrated_from": null,
  "checklist": {
    "dismissed": true,
    "steps": {
      "template_design": false,
      "visual_editor": false,
      "first_document": false,
      "automatic_invoicing": false
    },
    "completed_count": 0,
    "total": 4,
    "visual_editor_template_id": null
  }
}
```

## 401

Missing or unknown `X-Auth-Token`, or the shop uninstalled the app.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "unauthorized"
}
```

## 403

`v3_required`: the shop still runs the previous dashboard. `paid_plan_required`: API access needs a paid plan.

```json
{
  "errors": [
    "API access requires a paid plan"
  ],
  "code": "paid_plan_required"
}
```

## 422

The request failed validation. Nothing was saved.

```json
{
  "errors": [
    "id is missing"
  ]
}
```

## 429

Rate limited: cost-weighted per key (reads cost less than writes). Wait `Retry-After` seconds; see `X-RateLimit-*` headers.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited"
}
```

