ActiveCampaign Flows API is one of 57 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Flows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
5 operations
across 5 paths,
and defines 61 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://{youraccountname}.api-us1.com/api/3.
The identity and technical contract details declared by the specification.
FlowExecutionReadDetail
object
23 properties
9 required
TriggerTypeEnum
string
INBOUNDANYMESSAGE - Inbound Any Message INBOUNDSPECIFICMESSAGE - Inbound Specific Message OUTBOUNDCAMPAIGNAPI - Outbound Campaign Api OUTBOUNDCAMPAIGNCSV - Out…
FlowExecutionContactReadDetail
object
13 properties
8 required
WhatsAppMessageWithoutContext
object
28 properties
27 required
LanguageEnum
string
af - Afrikaans sq - Albanian ar - Arabic az - Azerbaijani bn - Bengali bg - Bulgarian ca - Catalan zhCN - Chinese (CHN) zhHK - Chinese (HKG) zhTW - Chinese (TA…
FlowStepTimeWindow
object
4 properties
1 required
FlowExecutionCreateRequestExecuteForEnum
string
LIST - LIST
StepConditionalCondition
object
4 properties
4 required
NextActionEnum
string
ANYRESPONSE - Any Response BUTTONRESPONSE - Button Response CONTINUE - Continue
WhatsAppTemplateStatusEnum
string
draft - Draft approved - Approved inappeal - In Appeal pending - Pending rejected - Rejected pendingdeletion - Pending Deletion deleted - Deleted disabled - Di…
BodyFileTypeEnum
string
URL - Url UPLOAD - Upload
WeekdayEnum
integer
0 - Monday 1 - Tuesday 2 - Wednesday 3 - Thursday 4 - Friday 5 - Saturday 6 - Sunday
FlowExecutionStepReadDetailStatusEnum
string
WAITINGTOSTART - Waiting To Start NOTEXECUTED - Not Executed RUNNING - Running COMPLETED - Completed CANCELED - Canceled FAILED - Failed EXPIRED - Expired
FlowExecutionEditSourceEnum
string
HUBSPOT - Hubspot API - Api FRONTEND - Frontend
ComparisonEnum
string
exact - Exact !exact - Different gte - Gte gt - Gt lte - Lte lt - Lt isnull - Is Null !isnull - Not Null icontains - Contains !icontains - Not Contains
FlowVersionSimpleRead
object
15 properties
4 required
FlowExecutionEdit
object
21 properties
5 required
CategoryEnum
string
ACCOUNTUPDATE - Account Update PAYMENTUPDATE - Payment Update PERSONALFINANCEUPDATE - Personal Finance Update SHIPPINGUPDATE - Shipping Update RESERVATIONUPDAT…
ChannelProviderEnum
string
METACLOUDAPI - Meta Cloud Api TECHPROVIDERCLOUDAPI - Tech Provider Cloud Api D360CLOUDAPI - D360 Cloud Api 360DIALOG - Dialog360
AnswerOptionsRenderEnum
string
BUTTONS - Buttons LIST - List EMOJIS - Emojis NUMBERS - Numbers
StepConditionalMultilpePath
object
1 property
1 required
FlowSimpleRead
object
11 properties
5 required
MessageStatusEnum
string
new - New retry - Retry accepted - Accepted sending - Sending sent - Sent receiving - Receiving received - Received delivered - Delivered undelivered - Undeliv…
WhatsAppMessage
object
29 properties
28 required
FlowExecutionList
object
19 properties
3 required
FlowExecutionContactStatusEnum
string
READY - Ready RUNNING - Running COMPLETED - Completed CANCELED - Canceled EXPIRED - Expired FAILED - Failed
FlowExecutionStatusEnum
string
PROCESSING - Processing READY - Ready AWAITINGCONFIRMATION - Awaiting Confirmation CONFIRMED - Confirmed STARTING - Starting RUNNING - Running COMPLETED - Comp…
FlowStatusEnum
string
DRAFT - Draft PUBLISHED - Published
FlowVersionSimpleListRead
object
14 properties
3 required
AnswerTypeEnum
string
ANY - Any FREETEXT - Free Text SINGLEOPTION - Single Option NUMBER - Number URL - Url EMAIL - Email FILE - File DOCUMENT - Document VIDEO - Video IMAGE - Image…
ChannelTypeEnum
string
WHATSAPP - Whatsapp EMAIL - Email INSTAGRAM - Instagram FBMESSENGER - Fb Messenger TELEGRAM - Telegram SMS - Sms VOICE - Voice
FlowExecutionCreateRequest
object
3 properties
2 required
ContactNote
object
5 properties
4 required
FlowExecutionExecuteForEnum
string
FILTERS - Filters LIST - List ALL - All
ContactMessage
object
7 properties
WhatsAppTemplateSimpleRead
object
10 properties
5 required
MaxWaitTimeUnitEnum
string
SECOND - Second MINUTE - Minute HOUR - Hour DAY - Day
ActionRequestMethodEnum
string
GET - Get POST - Post PUT - Put PATCH - Patch DELETE - Delete
FlowListRead
object
23 properties
5 required
PaginatedFlowExecutionListList
object
4 properties
2 required
FlowExecutionContactListSimple
object
9 properties
4 required
LocationMessage
object
6 properties
3 required
FlowExecutionStepWhatsAppMessage
object
1 property
1 required
PaginatedFlowExecutionContactListSimpleList
object
4 properties
2 required
MessageSourceEnum
string
INBOUND - Inbound INBOX - Inbox AUTORESPONSE - Auto Response API - Api BROADCAST - Broadcast FLOW - Flow
FlowStepContactUpdateCustomProperty
object
2 properties
2 required
ChannelStatusEnum
string
NEW - New ACTIVE - Active INACTIVE - Inactive
FlowStepEdit
object
This class is not useful other than for the OpenAPI Schema.
74 properties
11 required
MessageTypeEnum
string
audio - Audio voice - Voice button - Button document - Document text - Text image - Image interactive - Interactive order - Order sticker - Sticker system - Sy…
FlowExecutionStepReadDetail
object
13 properties
2 required
FlowExecutionContactFilterEdit
object
4 properties
3 required
TimeWindowTypeEnum
string
INWORKINGHOURS - In Working Hours CUSTOM - Custom
SimpleUser
object
6 properties
2 required
AnswerPhoneDefaultCountryEnum
string
AF - Afghanistan AX - Åland Islands AL - Albania DZ - Algeria AS - American Samoa AD - Andorra AO - Angola AI - Anguilla AQ - Antarctica AG - Antigua and Barbu…
UploadedAccountFile
object
5 properties
3 required
ContactTag
object
2 properties
2 required
ContactReadSimple
object
12 properties
4 required
PatchedContactEdit
object
21 properties
SimpleChannel
object
8 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ActiveCampaign publishes across the network.
