Update confirmation

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

PATCH/preorders/notification_settings/confirmation

Costs 2 rate-limit points · Rate limits

Switch the preorder confirmation email and SMS on or off, and whether customers may cancel their preorder from the email.

Deep partial: absent fields are unchanged, unknown or read-only keys are rejected. Errors are 422 keyed "notification_setting.<field>". Returns the notification setting.

Also searched asturn off the preorder confirmation emailedit preorder notificationsenable preorder emaildisable preorder sms

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

email_enabledboolean
Send the preorder confirmation email.
sms_enabledboolean
Send the preorder confirmation SMS; with STOQ SMS, the first switch-on pauses all SMS until STOQ reviews the content.
customer_cancellation_enabledboolean
Let customers cancel their preorder from the link in the confirmation email.

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

Invalid fields: one details entry per field error, its path the canonical section path. Nothing was saved.

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/preorders/notification_settings/confirmation

curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email_enabled": true,
    "sms_enabled": true,
    "customer_cancellation_enabled": true
  }'

const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation", {
  method: "PATCH",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email_enabled": true,
    "sms_enabled": true,
    "customer_cancellation_enabled": true
  }),
});
const data = await res.json();

import os
import requests

res = requests.patch(
    "https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
    json={
        "email_enabled": True,
        "sms_enabled": True,
        "customer_cancellation_enabled": True
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation")
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,
  customer_cancellation_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

No body

{
  "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": [
    "widget.button.text_color must be a hex color"
  ],
  "code": "invalid_params",
  "details": [
    {
      "code": "invalid_params",
      "message": "must be a hex color",
      "path": "widget.button.text_color",
      "value": "blue",
      "expected": {
        "type": "string"
      }
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}