Skip to content

Update confirmation settings

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.

Returns

  • keystring
    Example: confirmation
  • email_enabledboolean
    Example: true
  • sms_enabledboolean
    Example: false
  • customer_cancellation_enabledboolean
    Example: true

Errors

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.

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/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
  }'
Response
{
  "key": "confirmation",
  "email_enabled": true,
  "sms_enabled": false,
  "customer_cancellation_enabled": true
}