---
title: "Update pages"
description: "Update the Preorder pages settings (Preorders > Settings > Pages): the Preorder button on the home, collection and search pages, and the collection-page badge rule. Shop-wide, not per offer. Locations and markets are PAT"
url: https://docs.stoqapp.com/v2-reference/preorders-settings/update-pages/
api: "API v2 reference"
method: PATCH
path: "/preorders/settings/pages"
---

# Update pages

`PATCH https://app.stoqapp.com/api/v2/external/preorders/settings/pages`

Update the Preorder pages settings (Preorders > Settings > Pages): the Preorder button on the home, collection and search pages, and the collection-page badge rule. Shop-wide, not per offer. Locations and markets are [`PATCH /account/markets`](https://docs.stoqapp.com/v2-reference/account-markets/update-a-market/); CSS selectors are [`PATCH /preorders/settings/developer`](https://docs.stoqapp.com/v2-reference/preorders-settings/update-developer/).

**Note:** Deep partial: absent fields are unchanged; unknown keys are rejected. Returns the pages section.

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

- `home` (object)
  - `enabled` (boolean): Show the Preorder button on products listed on the home page.
- `collection` (object)
  - `enabled` (boolean): Show the Preorder button on products listed on collection pages.
  - `show_badge_if_any_variant_is_preorder` (boolean): Show the offer's preorder badge on a product card when any variant is on preorder, not only the variant the card shows first. The editor shows it under Collection page; it applies to every product list with the Preorder button on. The badge shows only for offers with Add badge on. Turning collection pages on does not need it: leave it out unless the merchant asks about the badge.
- `search` (object)
  - `enabled` (boolean): Show the Preorder button on products listed on search results pages.

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

## Example request

```sh
curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/settings/pages" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "home": {
      "enabled": true
    },
    "collection": {
      "enabled": true,
      "show_badge_if_any_variant_is_preorder": true
    },
    "search": {
      "enabled": true
    }
  }'
```

## 200

Success: the updated resource.

## 202

Saved. Returns the updated section, with also_changed for cascades.

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

Invalid fields: one `details` entry per field error, its `path` the canonical section path. Nothing was saved.

```json
{
  "errors": [
    "widget.button.text_color must be a hex color"
  ],
  "code": "invalid_params",
  "details": [
    {
      "code": "invalid_params",
      "message": "must be a hex color",
      "path": "widget.button.text_color",
      "value": "blue",
      "expected": {
        "type": "string"
      }
    }
  ]
}
```

## 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
    }
  ]
}
```