How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ActiveCampaign

ActiveCampaign WhatsApp API

The WhatsApp API from ActiveCampaign — 13 operation(s) for listing, retrieving, updating and deleting WhatsApp message templates, sending a template message to a recipient phone number with template variables, and reading conversations and flow executions on the WhatsApp channel.

Documentation Provider Profile APIs.io OpenAPI GitHub

ActiveCampaign WhatsApp API is one of 43 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WhatsApp, Messaging, and Channels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 13 operations across 10 paths, organized into 3 resource areas, and defines 86 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://{youraccountname}.api-us1.com/api/3.

13 operations 10 paths 86 schemas 1 DELETE7 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{youraccountname}.api-us1.com/api/3
Authentication
API Key
Resource Areas
3

Authentication & Security 1

ActiveCampaign WhatsApp API declares 1 security scheme for authenticating requests. An API key is passed in the header as Token (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 7 GET, 1 PATCH, 2 POST, 2 PUT. They span 3 resource areas: Templates, Flows, Conversations. Each is listed below with its method, path, parameters, and response codes.

Templates 5
GET
/channel/whatsapp/channels/whatsapp/template
List WhatsApp Templates
List WhatsApp Templates 10 params → 200
GET
/channel/whatsapp/channels/whatsapp/template/{id}
Get WhatsApp Template
Get WhatsApp Template 1 param → 200
PUT
/channel/whatsapp/channels/whatsapp/template/{id}
Update WhatsApp Template
channels_whatsapp_template_update 1 param body → 200
DELETE
/channel/whatsapp/channels/whatsapp/template/{id}
Delete WhatsApp Template
Delete WhatsApp Template 1 param → 204
POST
/channel/whatsapp/channels/whatsapp/template/{id}/send
Send a WhatsApp Template
Send a WhatsApp Template Message 1 param body → 201
Flows 5
GET
/channel/whatsapp/flow-execution
List Flow Executions
List Flow Execution 4 params → 200
GET
/channel/whatsapp/flow-execution-contact
List Flow Execution Contacts
List Flow Execution Contact 10 params → 200
GET
/channel/whatsapp/flow-execution-contact/{id}
Get Flow Execution Contact by Id
Get Flow Execution Contact 1 param → 200
GET
/channel/whatsapp/flow-execution/{id}
Get Flow Execution
Get Flow Execution 1 param → 200
POST
/channel/whatsapp/flow/{id}/run
Create a Flow Execution
Create a Flow Execution 1 param body → 201
Conversations 3
GET
/channel/whatsapp/inbox/conversation
List Conversations
List Conversations 4 params → 200
PUT
/channel/whatsapp/inbox/conversation/{id}/update
Update a conversation
Update a Conversation 1 param body → 200
PATCH
/channel/whatsapp/inbox/conversation/{id}/update
Partially Update a Conversation
Partially update a Conversation 1 param body → 200

Schemas 86

The contract defines 86 schemas that model the data the API accepts and returns. The most detailed are FlowStepEdit (74 properties), WhatsAppMessage (29 properties), WhatsAppMessageWithoutContext (28 properties), WhatsAppMessageSimple (26 properties). Each schema is shown below with its type and property counts.

ActionRequestMethodEnum
string
GET - Get POST - Post PUT - Put PATCH - Patch DELETE - Delete
AnswerOptionsRenderEnum
string
BUTTONS - Buttons LIST - List EMOJIS - Emojis NUMBERS - Numbers
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…
AnswerTypeEnum
string
ANY - Any FREETEXT - Free Text SINGLEOPTION - Single Option NUMBER - Number URL - Url EMAIL - Email FILE - File DOCUMENT - Document VIDEO - Video IMAGE - Image…
BlankEnum
BodyFileTypeEnum
string
URL - Url UPLOAD - Upload
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
ChannelStatusEnum
string
NEW - New ACTIVE - Active INACTIVE - Inactive
ChannelTypeEnum
string
WHATSAPP - Whatsapp EMAIL - Email INSTAGRAM - Instagram FBMESSENGER - Fb Messenger TELEGRAM - Telegram SMS - Sms VOICE - Voice
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
ContactDetailRead
object
20 properties 10 required
ContactDetailReadPublic
object
16 properties 9 required
ContactListReadPublic
object
13 properties 7 required
ContactMessage
object
7 properties
ContactNote
object
5 properties 4 required
ContactNoteRead
object
5 properties 4 required
ContactReadSimple
object
12 properties 4 required
ContactTag
object
2 properties 2 required
ConversationEdit
object
9 properties 5 required
ConversationReadSimple
object
10 properties 7 required
ConversationSourceEnum
string
INBOX - Inbox AUTORESPONSE - Auto Response API - Api BROADCAST - Broadcast FLOW - Flow UNKNOWN - Unknown
ConversationStatusEnum
string
CREATED - Created FLOW - Flow NEW - New INPROGRESS - In Progress RESOLVED - Resolved CLOSED - Closed
ConversationTag
object
2 properties 2 required
CreateWhatsAppMessage
object
8 properties
FlowExecutionContactFilterEdit
object
4 properties 3 required
FlowExecutionContactListSimple
object
9 properties 4 required
FlowExecutionContactReadDetail
object
13 properties 8 required
FlowExecutionContactStatusEnum
string
READY - Ready RUNNING - Running COMPLETED - Completed CANCELED - Canceled EXPIRED - Expired FAILED - Failed
FlowExecutionCreateRequest
object
3 properties 2 required
FlowExecutionCreateRequestExecuteForEnum
string
LIST - LIST
FlowExecutionEdit
object
21 properties 5 required
FlowExecutionEditSourceEnum
string
HUBSPOT - Hubspot API - Api FRONTEND - Frontend
FlowExecutionExecuteForEnum
string
FILTERS - Filters LIST - List ALL - All
FlowExecutionList
object
19 properties 3 required
FlowExecutionReadDetail
object
23 properties 9 required
FlowExecutionStatusEnum
string
PROCESSING - Processing READY - Ready AWAITINGCONFIRMATION - Awaiting Confirmation CONFIRMED - Confirmed STARTING - Starting RUNNING - Running COMPLETED - Comp…
FlowExecutionStepReadDetail
object
13 properties 2 required
FlowExecutionStepReadDetailStatusEnum
string
WAITINGTOSTART - Waiting To Start NOTEXECUTED - Not Executed RUNNING - Running COMPLETED - Completed CANCELED - Canceled FAILED - Failed EXPIRED - Expired
FlowExecutionStepWhatsAppMessage
object
1 property 1 required
FlowListRead
object
23 properties 5 required
FlowSimpleRead
object
11 properties 5 required
FlowStatusEnum
string
DRAFT - Draft PUBLISHED - Published
FlowStepContactUpdateCustomProperty
object
2 properties 2 required
FlowStepEdit
object
This class is not useful other than for the OpenAPI Schema.
74 properties 11 required
FlowStepTimeWindow
object
4 properties 1 required
FlowVersionSimpleListRead
object
14 properties 3 required
FlowVersionSimpleRead
object
15 properties 4 required
InboxContactURL
object
3 properties 2 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…
LocationMessage
object
6 properties 3 required
MaxWaitTimeUnitEnum
string
SECOND - Second MINUTE - Minute HOUR - Hour DAY - Day
MessageSourceEnum
string
INBOUND - Inbound INBOX - Inbox AUTORESPONSE - Auto Response API - Api BROADCAST - Broadcast FLOW - Flow
MessageStatusEnum
string
new - New retry - Retry accepted - Accepted sending - Sending sent - Sent receiving - Receiving received - Received delivered - Delivered undelivered - Undeliv…
MessageTypeEnum
string
audio - Audio voice - Voice button - Button document - Document text - Text image - Image interactive - Interactive order - Order sticker - Sticker system - Sy…
NextActionEnum
string
ANYRESPONSE - Any Response BUTTONRESPONSE - Button Response CONTINUE - Continue
NullEnum
PaginatedContactListReadPublicList
object
4 properties 2 required
PaginatedConversationReadSimpleList
object
4 properties 2 required
PaginatedFlowExecutionContactListSimpleList
object
4 properties 2 required
PaginatedFlowExecutionListList
object
4 properties 2 required
PaginatedWhatsAppTemplateSimpleReadList
object
4 properties 2 required
PatchedContactEdit
object
21 properties
PatchedContactEditPublic
object
14 properties
PatchedConversationEdit
object
9 properties
PatchedWhatsAppTemplateRead
object
11 properties
RoleSimple
object
5 properties 3 required
SimpleChannel
object
8 properties 2 required
SimpleUser
object
6 properties 2 required
StepConditionalCondition
object
4 properties 4 required
StepConditionalMultilpePath
object
1 property 1 required
TimeWindowTypeEnum
string
INWORKINGHOURS - In Working Hours CUSTOM - Custom
TriggerTypeEnum
string
INBOUNDANYMESSAGE - Inbound Any Message INBOUNDSPECIFICMESSAGE - Inbound Specific Message OUTBOUNDCAMPAIGNAPI - Outbound Campaign Api OUTBOUNDCAMPAIGNCSV - Out…
UploadedAccountFile
object
5 properties 3 required
UserBasicEdit
object
1 property 1 required
UserList
object
8 properties 8 required
UserSimple
object
7 properties 7 required
WeekdayEnum
integer
0 - Monday 1 - Tuesday 2 - Wednesday 3 - Thursday 4 - Friday 5 - Saturday 6 - Sunday
WhatsAppMessage
object
29 properties 28 required
WhatsAppMessageSimple
object
26 properties 23 required
WhatsAppMessageWithoutContext
object
28 properties 27 required
WhatsAppTemplateRead
object
11 properties 5 required
WhatsAppTemplateSend
object
2 properties 1 required
WhatsAppTemplateSendPublicResponse
object
2 properties 2 required
WhatsAppTemplateSimpleRead
object
10 properties 5 required
WhatsAppTemplateStatusEnum
string
draft - Draft approved - Approved inappeal - In Appeal pending - Pending rejected - Rejected pendingdeletion - Pending Deletion deleted - Deleted disabled - Di…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-whatsapp-api-openapi.yml Raw ↑

Other APIs ActiveCampaign publishes across the network.

ActiveCampaign Accounts API
AE Profile APIs.io
ActiveCampaign Addresses API
AE Profile APIs.io
ActiveCampaign AI API
AE Profile APIs.io
ActiveCampaign Automations API
AE Profile APIs.io
ActiveCampaign Branding API
AE Profile APIs.io
ActiveCampaign Broadcasts API
AE Profile APIs.io
ActiveCampaign Bulk Import API
AE Profile APIs.io
ActiveCampaign Calendars API
AE Profile APIs.io
ActiveCampaign Campaigns API
AE Profile APIs.io
ActiveCampaign Contacts API
AE Profile APIs.io
ActiveCampaign Credits API
AE Profile APIs.io
ActiveCampaign Custom Objects API
AE Profile APIs.io
#WhatsApp#Messaging#Channels
← Back to A APIs
API Details
ID
activecampaign:activecampaign-whatsapp-api
Base URL
https://{youraccountname}.api-us1.com/api/3
Docs
https://developers.activecampaign.com/reference/list-whatsapp-templates
Provider
ActiveCampaign
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=activecampaign-whatsapp-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/activecampaign-whatsapp-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ActiveCampaign WhatsApp API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.