Skip to content

Get channel settings

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

GET/back_in_stock/settings/channels

Costs 1 rate-limit point · Rate limits

Read back-in-stock notification channel settings.

Each switch decides both whether shoppers can sign up on that channel and whether alerts go out on it. Whether automatic restock alerts send at all is a separate switch: enabled on GET /back_in_stock/notification_settings/restock_alert. The email sender and SMS number are under GET /account/sending. Change these with PATCH /back_in_stock/settings/channels.

Also searched asget channelsshow channelsview notification channelswhich channels are enabledchannels

Returns

  • emailobject
    Show 1 child attributeHide child attributes
    • enabledboolean
      Example: true
  • smsobject
    Show 1 child attributeHide child attributes
    • enabledboolean
      Example: true

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/channels
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/channels" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "email": {
    "enabled": true
  },
  "sms": {
    "enabled": true
  }
}