Update channels

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
Show 1 child attributeHide child attributes
- enabledboolean
  Example: true
smsobject
Show 1 child attributeHide child attributes
- enabledboolean
  Example: true

Returns

alerts_enabledboolean
Example: true
emailobject
Show 1 child attributeHide child attributes
- enabledboolean
  Example: true
smsobject
Show 1 child attributeHide child attributes
- enabledboolean
  Example: true

Errors

401

Missing or invalid X-Auth-Token.

409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422

The request failed validation.

429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Every error has the same shape: see Errors.

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
    }
  }'

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)

Response

{
  "alerts_enabled": true,
  "email": {
    "enabled": true
  },
  "sms": {
    "enabled": true
  }
}

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

{
  "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
    }
  ]
}