ACactivecampaign
Flows

Create a Flow Execution

Create a Flow Execution of a Flow.

post/channel/whatsapp/flow/{id}/run

Request

  • Base URL
    https://{youraccountname}.api-us1.com/api/3
  • URL
    https://{youraccountname}.api-us1.com/api/3/channel/whatsapp/flow/{id}/run
  • Auth
    API key in header Token

Path parameters

idstring uuid required

A Flow Id to create a Flow Execution.

Request body

execute_for'LIST' required
  • LIST - LIST
has_priorityboolean

Specify as True if you want this execution to close any other running flows or conversations.

Response

statusstring required

The status of the Flow Execution.

execute_for'FILTERS' | 'LIST' | 'ALL' required
  • FILTERS - Filters
  • LIST - List
  • ALL - All
idstring uuid
has_priorityboolean
flow_execution_variablesunknown
start_onstring date-time nullable
num_contactsinteger
expiredinteger
runninginteger
completedinteger
canceledinteger
failedinteger
created_onstring date-time
avg_completion_timestring
status_reasonstring nullable required
status_triggered_byinteger nullable required
status_last_change_onstring date-time nullable required
source'HUBSPOT' | 'API' | 'FRONTEND'
  • HUBSPOT - Hubspot
  • API - Api
  • FRONTEND - Frontend
is_hiddenboolean

Changes

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