Skip to content

Set up flows automatically

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

POST/account/integrations/{channel}/flows/auto_setup

Costs 2 rate-limit points · Rate limits

Create the Klaviyo flows that send STOQ alerts for a campaign type, as the template editor's automatic setup does (klaviyo_email or klaviyo_sms).

campaign_type is "restock" (default) or "preorder". Fails with Klaviyo's error when it refuses; nothing is marked set up then.

Also searched asset up klaviyo flows automaticallyauto setup klaviyocreate klaviyo flows

Path parameters

  • channelstringRequired

    The integration channel whose flows to act on: klaviyo_email, klaviyo_sms or postscript.

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

  • campaign_typestring

    Which alerts the flows are for, back in stock (restock, the default) or preorder.

    One of restockpreorder
    Default "restock"
  • template_idinteger

    Id of one of the shop's notification templates; when given it must exist.

Returns

  • channelstring
    Example: klaviyo_email
  • campaign_typestring
    Example: preorder
  • set_upboolean
    Example: true

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 action refused the request for a reason that is not a single bad field.

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/account/integrations/{channel}/flows/auto_setup
curl -X POST "https://app.stoqapp.com/api/v2/external/account/integrations/{channel}/flows/auto_setup" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign_type": "preorder"
  }'
Response
{
  "channel": "klaviyo_email",
  "campaign_type": "preorder",
  "set_up": true
}