REreacherapp
Workflows

Create a workflow

Changed on

Create a draft. A draft sends nothing: it reaches creators only at POST /workflows/{id}/publish. Requires read_write scope and an Idempotency-Key. Validate first with POST /workflows/validate — a definition with blocking issues saves fine but cannot be published.

post/workflows

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/workflows
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Headers

Idempotency-Keystring nullable

Request body

definitionobject required

The workflow document: name, a trigger and its steps. Validated strictly on the way in. GET /workflows/templates returns working examples, GET /workflows/conditions the rule vocabulary for this shop, and POST /workflows/validate reports what is wrong with one.

settingsobject nullable

Exclusions (groups, lists, blacklist), dailyMessageLimits and dailyInviteLimits keyed by weekday, skipCreatorsInOtherWorkflows, and timezone — which decides when the daily budget resets.

created_fromobject nullable

Provenance, e.g. {"type": "template", "template_id": "..."}.

Response

Successful Response

Changes