Get compliance settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/settings/complianceCosts 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_requiredbooleanExample:truenotestringExample:string
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/compliance" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/settings/compliance", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/back_in_stock/settings/compliance",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/settings/compliance")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"optin_required": true,
"note": "string"
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}