REreacherapp
Workflows

Update a workflow

Changed on

Save the draft. Omitted fields are left alone; a supplied definition or settings replaces the stored one outright rather than merging, so send the whole object. Updating a running workflow changes only the draft — republish to put it in front of creators.

patch/workflows/{workflow_id}

Request

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

Path parameters

workflow_idstring required

The workflow's uuid, as POST /workflows/list returns it.

Headers

Idempotency-Keystring nullable

Request body

definitionobject nullable

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.

namestring nullable
descriptionstring nullable

Response

Successful Response

Changes