Send WhatsApp messages and manage chats, groups, contacts, the send queue and catalog products through a Z-API instance.
Explore 41 workflow actions for Z-API WhatsApp, including account permissions and operation limits.
12 read actions29 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.
Archive or unarchive a chat
Write
Archives or unarchives a chat.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Check if a number has WhatsApp
Read
Checks whether a number has a WhatsApp account.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
Create or update a product
Write
Creates a catalog product, or updates the one with the same retailer ID.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a chat
Write
Deletes a chat.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a message
Write
Deletes a sent or received message from a chat.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a product
Write
Deletes a catalog product.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a queued message
Write
Removes one message from the send queue.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a product
Read
Reads one catalog product.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
Get contact metadata
Read
Reads a contact's name and profile text.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
Get device data
Read
Reads the connected phone's number, name, profile text and device model.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
Get group metadata
Read
Reads a group's name, description, owner, settings and participants (without its invitation link).
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
Get instance status
Read
Checks whether the instance is connected to WhatsApp.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
Leave a group
Write
Leaves a group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
List a business's products
Read
Lists the catalog products of a WhatsApp Business number.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
List chats
Read
Lists the instance's chats.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
List contacts
Read
Lists the phone's WhatsApp contacts.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
List groups
Read
Lists the instance's groups.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
List products
Read
Lists your WhatsApp Business catalog products.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
List queued messages
Read
Lists messages waiting in the instance's send queue (cursor pages).
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
Mark a message as read
Write
Marks a message in a chat as read.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pin or unpin a chat
Write
Pins or unpins a chat.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post a text status
Write
Posts a text to your WhatsApp status.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post an image status
Write
Posts an image to your WhatsApp status.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove group participants
Write
Removes participants from a group you administer.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reply to a message
Write
Replies to a message in a chat, quoting it.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a button list
Write
Sends a message with quick reply buttons.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a contact
Write
Sends a contact card to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a document
Write
Sends a document to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a link
Write
Sends a link with a preview to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a location
Write
Sends a fixed location to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a reaction
Write
Reacts to a message with an emoji.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a sticker
Write
Sends a sticker to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a text message
Write
Sends a text message to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a video
Write
Sends a video to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send an audio
Write
Sends an audio to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send an image
Write
Sends an image to a contact or group.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send an option list
Write
Sends a message with a selectable option list.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a group description
Write
Changes a group's description.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a group name
Write
Changes a group's name.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a group photo
Write
Changes a group's image.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update group settings
Write
Changes who can message, edit settings and add members, and whether joins need approval.
Permissions and limits
Account permissions
A Z-API instance (ID and token) with a connected WhatsApp account, and the account security token if it is turned on
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 Z-API WhatsApp. A saved workflow is not a completed provider action.
Messaging ยท CONNECTION
