Skip to content
STOQDevelopers
Open STOQ

Update notifications

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

PATCH
/preorders/notifications/{locale}
curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/preorders/notifications/example \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "preorder_email_enabled": true, "preorder_sms_enabled": true, "preorder_cancellation_enabled": true, "notify_payment_collection_enabled": true, "email_provider": "stoq", "sms_provider": "twilio", "email_from_name": "Summer Sneaker Drop", "shipping_update_subject": "2026-07-01T00:00:00Z", "shipping_update_header": "2026-07-01T00:00:00Z", "shipping_update_description": "2026-07-01T00:00:00Z", "payment_collection_email_subject": "string", "payment_collection_email_header": "string", "payment_collection_email_description": "string", "payment_collection_email_button_text": "Preorder now", "klaviyo_shipping_update_flow_name": "Summer Sneaker Drop", "klaviyo_payment_failed_flow_name": "Summer Sneaker Drop" }'

Update shop-level preorder notification settings for a locale. This edits shop-level toggles, provider (email_provider/sms_provider), sender name, and shipping-update / payment-collection copy — NOT the confirmation email body (use update_preorder_template for that). email_provider and sms_provider accept only the shop’s enabled provider keys.

Note: Deep partial. Validates booleans, provider enums, locale, length, and plain-text content; then runs Setting validations and provider/SMS verification callbacks.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
locale
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
preorder_email_enabled
boolean
preorder_sms_enabled
boolean
preorder_cancellation_enabled
boolean
notify_payment_collection_enabled
boolean
email_provider
Allowed values: stoq klaviyo flow
sms_provider
Allowed values: twilio telnyx infobip klaviyo postscript
email_from_name
string
>= 1 characters
shipping_update_subject
string
>= 1 characters
shipping_update_header
string
>= 1 characters
shipping_update_description
string
>= 1 characters
payment_collection_email_subject
string
>= 1 characters
payment_collection_email_header
string
>= 1 characters
payment_collection_email_description
string
>= 1 characters
payment_collection_email_button_text
string
>= 1 characters
klaviyo_shipping_update_flow_name
string
>= 1 characters
klaviyo_payment_failed_flow_name
string
>= 1 characters

Example 

{
  "preorder_email_enabled": true,
  "preorder_sms_enabled": true,
  "preorder_cancellation_enabled": true,
  "notify_payment_collection_enabled": true,
  "email_provider": "stoq",
  "sms_provider": "twilio",
  "email_from_name": "Summer Sneaker Drop",
  "shipping_update_subject": "2026-07-01T00:00:00Z",
  "shipping_update_header": "2026-07-01T00:00:00Z",
  "shipping_update_description": "2026-07-01T00:00:00Z",
  "payment_collection_email_subject": "string",
  "payment_collection_email_header": "string",
  "payment_collection_email_description": "string",
  "payment_collection_email_button_text": "Preorder now",
  "klaviyo_shipping_update_flow_name": "Summer Sneaker Drop",
  "klaviyo_payment_failed_flow_name": "Summer Sneaker Drop"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success — the updated resource.

Media typeapplication/json
object

Example generated

{}

202

Section titled “202”

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object
job_id
string
status_url
string

Example 

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

401

Section titled “401”

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Unauthorized"
  ]
}

404

Section titled “404”

The resource does not exist for this shop, or the action path is not registered.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Offer not found"
  ]
}

422

Section titled “422”

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "name is required"
  ]
}

429

Section titled “429”

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

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example 

{
  "errors": [
    "Rate limit exceeded"
  ]
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support