Workflows

Update a workflow

Also used to activate or pause via status.

patch/v1/workflows/{id}

Request

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

Path parameters

idstring required

Workflow id.

Request body

namestring
triggerstring
reentry'never' | 'after_exit' | 'always'
exitOnReplyboolean

Exit a contact from this workflow as soon as they reply to any email (an email.received from them).

status'draft' | 'active' | 'paused'

Response

The updated workflow.

workflowIdstring required
projectIdstring
namestring required
status'draft' | 'active' | 'paused' required
triggerstring required

event:<name>, contact.created, segment:enter:<ref>, or segment:exit:<ref>.

reentry'never' | 'after_exit' | 'always' required
exitOnReplyboolean
enteredinteger
completedinteger
activeinteger
createdAtstring date-time required

Changes

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