Generated by API Evangelist
Written by API Evangelist tooling for ActiveCampaign's API. It is a proposal applied on top of the contract, not a document ActiveCampaign publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for WhatsApp Conversations API
version: 1.0.0
extends: openapi/activecampaign-conversations-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/channel/whatsapp/inbox/conversation'].get
update:
x-apievangelist-phrasing:
intent: List WhatsApp inbox conversations
effect: read
questions:
- Which WhatsApp conversations are in my ActiveCampaign inbox?
- Can I see only the WhatsApp chats with one contact?
- Can I page through WhatsApp conversations and search them?
instructions:
- text: List WhatsApp conversations with contact {contact}.
slots:
contact: query.contact
- text: Search WhatsApp inbox conversations for {search}.
slots:
search: query.search
- text: Show page {page} of WhatsApp conversations, {page_size} per page.
slots:
page: query.page
page_size: query.page_size
method: generated
generated: '2026-09-26'
- target: $.paths['/channel/whatsapp/inbox/conversation/{id}/update'].put
update:
x-apievangelist-phrasing:
intent: Replace a WhatsApp conversation record
effect: write
questions:
- How do I fully overwrite a WhatsApp conversation with all its required fields?
- What fields must I send when replacing a whole conversation record?
instructions:
- text: Replace WhatsApp conversation {id} with contact {contact}, assignee {assigned}, source {source}, created {created_on}.
slots:
id: path.id
contact: requestBody.contact
assigned: requestBody.assigned
source: requestBody.source
created_on: requestBody.created_on
- text: Do a full update of conversation {id} setting every required field.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/channel/whatsapp/inbox/conversation/{id}/update'].patch
update:
x-apievangelist-phrasing:
intent: Change a WhatsApp conversation's status or assignee
effect: write
questions:
- Can I close a WhatsApp conversation without resending the whole record?
- How do I reassign a WhatsApp chat to another team?
instructions:
- text: Set the status of WhatsApp conversation {id} to {status}.
slots:
id: path.id
status: requestBody.status
- text: Assign conversation {id} to team {assigned_team}.
slots:
id: path.id
assigned_team: requestBody.assigned_team
- text: Tag WhatsApp conversation {id} with {tags}.
slots:
id: path.id
tags: requestBody.tags
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.