Update channel settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/settings/channelsCosts 2 rate-limit points · Rate limits
Update the back-in-stock email and SMS channel switches. Turning automatic alerts on or off is PATCH /back_in_stock/notification_settings/restock_alert; the email sender and SMS number are PATCH /account/sending.
Channel toggles are set via this PATCH: email.enabled, sms.enabled: e.g. { sms: { enabled: true } }. Enabling SMS for the first time triggers a restricted-content verification check; sends may be held until the shop is verified.
Also searched asedit channelschange channelsmodify channelsenable email notificationsturn on email alertsdisable email notificationsturn off email alertsenable smsturn on SMS alertsenable text notificationsdisable smsturn off SMS alertsstop text notifications
Headers
Idempotency-KeystringA 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 (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
emailobjectThe email channel switch.
Show 1 child attributeHide child attributes
enabledbooleanEmail alerts.
smsobjectThe SMS channel switch.
Show 1 child attributeHide child attributes
enabledbooleanSMS alerts. Turning this on for the first time holds sends until the shop is approved.
Returns
emailobjectShow 1 child attributeHide child attributes
enabledbooleanExample:true
smsobjectShow 1 child attributeHide child attributes
enabledbooleanExample:true
Errors
not_foundThe path is valid but nothing with that id exists in this store.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_paramsOne or more fields failed the action's schema.
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 -X PATCH "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/channels" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": {
"enabled": true
},
"sms": {
"enabled": true
}
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/settings/channels", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"email": {
"enabled": true
},
"sms": {
"enabled": true
}
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.stoqapp.com/api/v2/external/back_in_stock/settings/channels",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"email": {
"enabled": True
},
"sms": {
"enabled": True
}
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/settings/channels")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
email: {
enabled: true
},
sms: {
enabled: true
}
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"alerts_enabled": true,
"email": {
"enabled": true
},
"sms": {
"enabled": true
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"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
}
]
}{
"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
}
]
}