Send and manage WhatsApp messages, chats, contacts, groups and channels through a WaAPI instance.
Explore 107 workflow actions for WaAPI, including account permissions and operation limits.
47 read actions60 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add and update contact
Write
Creates a new contact or updates an existing one in the address book.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add customer note
Write
Adds a note to a customer chat for internal reference.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archive chat
Write
archive chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Block a contact
Write
Blocks a contact, preventing them from sending messages to the authenticated user.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change chat labels
Write
Add or remove labels on a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clear chat messages
Write
Clears all messages from a specific chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Client status of instance
Read
retrieve the status of your running client.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Create a channel
Write
Create a channel.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a community
Write
Create a new Community (parent group containing subgroups).
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create poll message
Write
Creates and sends an interactive poll message to a specified chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create quick reply
Write
Create a new quick reply.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete chat by id
Write
Delete chat by ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete contact
Write
Deletes a contact from the address book.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete message by id
Write
delete a message by id.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete quick reply
Write
Delete a quick reply by id.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete webhook subscription
Write
Remove a webhook subscription from an instance.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit a message
Write
Edit a previously sent message.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit scheduled event
Write
Edits an existing scheduled event message with updated details.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch messages from a chat
Read
Retrieve messages from a specific chat with optional filtering and media inclusion.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Forward a message
Write
Forward a message to another chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get all chats
Read
Retrieves a list of all chats with their latest messages and metadata.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get all contacts
Read
Retrieves a list of all contacts from the account, including saved contacts and users who have messaged you.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get all labels
Read
Retrieve all labels.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get async request status
Read
Retrieve the status or result of an async request by its reference UUID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get blocked contacts
Read
Retrieves a list of all blocked contacts.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get broadcast
Read
Retrieves broadcast list details for a specified contact.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get business categories
Read
List available business categories.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get business profile
Read
Retrieve a business profile.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get channel by id
Read
get channel by id.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get channels
Read
get your channels.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get chat by id
Read
Get chat by ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get chat ID from phone number
Read
Converts a phone number into the proper chat ID format.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get chat labels
Read
Get chat labels by chat ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get chats by labelId
Read
Get chats by label ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get common groups with contact
Read
Get list of groups that are in common between you and the specified contact.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get communities
Read
Retrieve all Communities the instance is a member of.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get community by id
Read
Retrieve a specific Community by its ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get community subgroups
Read
Retrieve all joined subgroups of a Community as full chat instances.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get contact about info
Read
Retrieves the about/status info for a specific contact.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get contact details by ID
Read
Retrieves detailed contact information for a specific contact using their ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get country code
Read
Get the country code for a given phone number.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get customer note
Read
Retrieves the note associated with a customer chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get disappearing durations
Read
Return the allowed disappearing-messages durations (in seconds).
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get disappearing messages
Read
Return the current disappearing-messages timer for a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get formatted number
Read
Format a phone number into standardized format.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get group info
Read
Get group info.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get group membership requests
Read
Get pending group membership requests.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get group participants
Read
Get group participants.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get label by id
Read
Get label by ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get message by ID
Read
Retrieve a specific message using its unique identifier.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get message info by id
Read
get a message info by id.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get message mentions
Read
Get mentions from a message.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get message reactions
Read
Get reactions for a specific message.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get pinned messages
Read
Retrieves all pinned messages from a specified chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get poll votes
Read
Retrieves the vote information for a specific poll message, including who voted for which options and the original poll message details.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get privacy settings
Read
Retrieve the authenticated account's privacy settings.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get quick replies
Read
List all quick replies configured on the business account.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Get the current Status privacy
Read
Retrieve the current Status privacy setting for the instance.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Is registered user
Read
Check if a given contactId is registered.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Leave community
Write
Leave a Community as the current user.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Link community subgroup
Write
Link one or more existing standalone groups to a Community as subgroups.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
List instances
Read
Retrieve a list of your instances.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
List webhook subscriptions
Read
Retrieve the webhook subscriptions registered on an instance.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Mark chat as unread
Write
Marks a specified chat conversation as unread.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mark chat messages as seen (blue ticks)
Write
Mark all messages in a chat as seen (read).
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mute chat
Write
Mute notifications for a specific chat either indefinitely or until a specified date.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pin chat
Write
Pins a chat to the top of the chat list.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pin message
Write
Pin a message in a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post a text or media status/story
Write
Publishes a status update visible to contacts per the user's privacy settings.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
React to message
Write
Add or remove a reaction emoji to/from a message.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reboot instance
Write
Reboots your instance.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove group participant
Write
Remove a participant from a group.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Retrieve basic client information
Read
Retrieve general information of the user connected to your instance.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Retrieve instance
Read
Retrieve a single instance by its ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Revoke status
Write
Revokes (deletes) a previously posted status/story update.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Revoke status message
Write
Revokes (deletes) a previously sent status message.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Search channels
Read
Search for channels.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Search messages
Read
Search for messages across all chats or within a specific chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
Send a media message (image, video, audio, document)
Write
Send a media file to a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a text message to a chat
Write
Send a text message to a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send community announcement
Write
Post an announcement to a Community.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send event message
Write
Creates and sends a calendar event message to a specified chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send event response
Write
Sends a response (RSVP) to a calendar event message.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send location
Write
Send a location message to a contact or group chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send typing state
Write
Sends typing state indicator to a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send vCard
Write
Send a vCard to a contact or group.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set business profile
Write
Update the authenticated business account's profile.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set device name
Write
Sets the device name and/or browser name displayed for the Web session.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set disappearing messages
Write
Set the disappearing-messages timer on a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set display name
Write
Sets the display name for the account.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set status
Write
Sets the status text for the connected account.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Star message
Write
Star a message by its ID.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Stop typing indicator
Write
Stops the typing indicator for a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Subscribe to channel
Write
subscribe to channel.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sync chat history
Write
Synchronizes the chat history for a specific chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unarchive chat
Write
unarchive chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unblock a contact
Write
Removes a contact from the blocked contacts list, allowing them to send messages and see your information again according to your privacy settings.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unlink community subgroup
Write
Unlink one or more subgroups from a Community.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unmute chat
Write
Removes mute settings from a specified chat, allowing notifications to be received again.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unpin chat
Write
Removes a chat from pinned status.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unpin message
Write
Unpin a message in a chat.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unstar message
Write
Remove star from a message.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unsubscribe from channel
Write
unsubscribe from channel.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update group info
Write
Update Group Information.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update group settings
Write
Update Group Settings.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update quick reply
Write
Update an existing quick reply by id.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Vote on poll
Write
Submits a vote on an existing poll message with the specified options.
Permissions and limits
Account permissions
A WaAPI API token (waapi.app, API tokens) and an instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in WaAPI. A saved workflow is not a completed provider action.
Messaging ยท CONNECTION
