REreacherapp
Workflows

Validate a workflow definition

Changed on

Blocking errors and warnings for a definition, without saving it. blocking > 0 is what publish refuses on. Call this before POST /workflows to avoid persisting a draft that cannot run.

post/workflows/validate

Request

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

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.

Response

Successful Response

Changes