Update notification settings

PATCH

/back_in_stock/notification_settings/{key}

curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/back_in_stock/notification_settings/example \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "enabled": true, "after_n_days": "string" }'

• Production

Turn a back-in-stock notification on or off, or change when the reminder sends. key is “signup_thank_you”, “restock_alert” or “reminder”. enabled (true/false) works on every key; for “restock_alert” it is the Notifications card’s “Send automatic notification” switch, so false stops automatic back-in-stock alerts. after_n_days (1 or more) is the reminder’s wait after the restock alert.

Note: Partial. after_n_days is only accepted for the reminder. Errors are 422 keyed “notification_setting.”.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

key

required

string

Request Body^required

Media typeapplication/json

object

enabled

after_n_days

Example

{
  "enabled": true,
  "after_n_days": "string"
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

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

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

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

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

404

The resource does not exist for this shop, or the action path is not registered.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Offer not found"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}