Skip to content

Verify a template's flow

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

POST/back_in_stock/templates/{key}/verify_flow

Costs 2 rate-limit points · Rate limits

Check that the Klaviyo or Postscript flow for one back-in-stock notification is set up, the same as the template page's Verify flow button. channel is "email" (Klaviyo email) or "sms" (Klaviyo SMS or Postscript, whichever is the SMS provider). Klaviyo is checked for a flow with the template's klaviyo_flow_name / klaviyo_sms_flow_name. Postscript has no flows API, so for Postscript this records your confirmation that the flow exists.

422 when the channel's provider is not Klaviyo/Postscript or is not connected. A flow Klaviyo cannot find is not an error: flow_verified is false and reason says why. The result also shows on GET /back_in_stock/templates/:key as email.klaviyo_flow_verified, sms.klaviyo_flow_verified and sms.postscript_flow_verified.

Also searched asverify klaviyo flowcheck my klaviyo flowverify postscript flowconfirm postscript flow setupis my klaviyo flow set up

Path parameters

  • keystringRequired

    Which notification's template: signup_thank_you, restock_alert or reminder.

    One of signup_thank_yourestock_alertreminder

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

  • channelstringRequired

    Flow to check, the email flow (Klaviyo) or the SMS flow (Klaviyo or Postscript).

    One of emailsms

Returns

  • keystring
    Example: restock_alert
  • channelstring
    Example: email
  • providerstring
    Example: klaviyo
  • flow_verifiedboolean
    Example: true
  • reasonstring, nullable

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.

POST/back_in_stock/templates/{key}/verify_flow
curl -X POST "https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}/verify_flow" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email"
  }'
Response
{
  "key": "restock_alert",
  "channel": "email",
  "provider": "klaviyo",
  "flow_verified": true,
  "reason": null
}