---
title: "Update the settings"
description: "Update back-in-stock settings for the shop: channels, delivery, compliance, tagging, merchant alerts and the signup widget, in one request."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-settings/update-the-settings/
api: "API v2 reference"
method: PATCH
path: "/back_in_stock/settings"
---

# Update the settings

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

Update back-in-stock settings for the shop: channels, delivery, compliance, tagging, merchant alerts and the signup widget, in one request.

**Note:** Accepts any combination of section blobs: channels, delivery, compliance, tagging, alerts, widget: deep partial. Every section is validated first; any error rejects the whole request (422, keyed "section.path") and nothing is saved. Unknown keys are rejected. widget takes the [`PATCH /back_in_stock/settings/widget`](https://docs.stoqapp.com/v2-reference/back-in-stock-settings/update-widget/) body, with widget.locale for its text. Turning each notification on or off is [`PATCH /back_in_stock/notification_settings/:key`](https://docs.stoqapp.com/v2-reference/back-in-stock-notification-settings/update-a-notification-setting/); the email sender and SMS number are [`PATCH /account/sending`](https://docs.stoqapp.com/v2-reference/account-sending/update-the-sending/); market setup is [`PATCH /account/markets`](https://docs.stoqapp.com/v2-reference/account-markets/update-a-market/).

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

- `channels` (string): e.g. `string`
- `delivery` (string): e.g. `string`
- `compliance` (string): e.g. `string`
- `tagging` (string): e.g. `string`
- `alerts` (string): e.g. `string`
- `widget` (string): e.g. `string`

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/back_in_stock/settings" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channels": "string",
    "delivery": "string",
    "compliance": "string",
    "tagging": "string",
    "alerts": "string",
    "widget": "string"
  }'
```

## 200

Success: the updated resource.

## 202

Accepted: async/bulk work was queued. Poll the returned job.

```json
{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}
```

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