Skip to content

Get compliance settings

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

GET/back_in_stock/settings/compliance

Costs 1 rate-limit point · Rate limits

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

With optin_required true, each new email signup gets a confirmation email (its copy is optin in GET /back_in_stock/settings/widget) and SMS signups count as confirmed at once. The response then adds a note: an unconfirmed signup is still on the waitlist and counted, but can't be alerted until it confirms. Each signup's state is optin_confirmed on GET /back_in_stock/signups. Change this with PATCH /back_in_stock/settings/compliance; resend confirmations with POST /back_in_stock/signups/resend_optin.

Also searched asget compliance settingsshow complianceview opt-in settingsis double opt-in enabledcompliance

Returns

  • optin_requiredboolean
    Example: true
  • notestring
    Example: string

Errors

404
not_found

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

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.

GET/back_in_stock/settings/compliance
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/compliance" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "optin_required": true,
  "note": "string"
}