Workflows

Enroll a contact

Manually start an execution for a contact (the workflow must be active). Re-entry is subject to the workflow's reentry policy.

post/v1/workflows/{id}/enroll

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/workflows/{id}/enroll
  • Auth: HTTP bearer

Path parameters

idstring required

Workflow id.

Request body

emailstring email required

Response

The new execution.

executionIdstring required
workflowIdstring required
projectIdstring
contactIdstring required
status'active' | 'waiting' | 'completed' | 'exited' | 'failed' | 'cancelled' required
currentNodeIdstring nullable
wakeAtstring date-time nullable
waitEventNamestring nullable
waitTimeoutAtstring date-time nullable
contextobject nullable
enteredAtstring date-time required
updatedAtstring date-time
completedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.