Skip to content

Update compliance settings

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

PATCH/back_in_stock/settings/compliance

Costs 2 rate-limit points · Rate limits

Update back-in-stock compliance settings (double opt-in).

The double-opt-in toggle is set via this PATCH: optin_required: e.g. { optin_required: true }. When enabled, signups must confirm via email before they are eligible for notifications (GDPR double opt-in).

Also searched asedit compliance settingschange compliance settingsrequire double opt-inenable double opt-inturn on double opt-inrequire opt-in confirmationgdpr opt-indisable double opt-inturn off double opt-inremove opt-in confirmation

Headers

  • Idempotency-Keystring

    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

  • optin_requiredboolean

    Double opt-in: a customer must confirm by email before the signup counts.

Returns

  • optin_requiredboolean
    Example: true

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The 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.

PATCH/back_in_stock/settings/compliance
curl -X PATCH "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/compliance" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "optin_required": true
  }'
Response
{
  "optin_required": true
}