Skip to content

Update channel settings

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

PATCH/back_in_stock/settings/channels

Costs 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-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

  • emailobject

    The email channel switch.

    Show 1 child attributeHide child attributes
    • enabledboolean

      Email alerts.

  • smsobject

    The SMS channel switch.

    Show 1 child attributeHide child attributes
    • enabledboolean

      SMS alerts. Turning this on for the first time holds sends until the shop is approved.

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.

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/channels
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
    }
  }'
Response
{
  "alerts_enabled": true,
  "email": {
    "enabled": true
  },
  "sms": {
    "enabled": true
  }
}