Send WhatsApp messages, polls, files and statuses through a GREEN-API instance, and manage chats, groups, contacts and the catalog.
Explore 70 workflow actions for GREEN-API for WhatsApp, including account permissions and operation limits.
28 read actions42 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 contact
Write
The method is used for adding a number to contacts, as well as adding a number to the primary device's (handset's) phonebook.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add group participant
Write
The method adds a participant to a group chat.
Permissions and limits
Account permissions
A GREEN-API 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
The method archives a chat. One can archive chats that have at least one incoming message.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Check WhatsApp availability
Read
The method checks WhatsApp account availability on a phone number.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Clear incoming notification queue
Write
The method is used to clear the incoming notification queue. The notification is stored in the queue for 24 hours and will be sent after configuring webhookUrl on the authorized instance.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clear outgoing message queue
Write
The method is used to clearing the queue of messages to be sent. Messages will be kept for 24 hours in the queue until instance will be authorized. Messages sending rate is managed by Messages sending delay parameter.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Count incoming queue
Read
The method is used to get the number of notifications in the incoming queue. Each notification is stored in the queue for 24 hours. Information in the GetWebhooksCount method is updated once every 10 seconds.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Count outgoing queue
Read
The method is used to get the number of messages in the queue for sending in WhatsApp. Each message is stored in the queue for 24 hours. The information in the GetMessagesCount method is updated once every 10 seconds.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Create collection
Write
To use this method, you must have a WhatsApp Business account.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create group
Write
The method is used to creating a group chat. When creating a group, it is required to simulate human work. It is required to create a group no more often than 1 group every 5 minutes.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create product
Write
To use this method, you must have a WhatsApp Business account.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete collection
Write
To use this method, you must have a WhatsApp Business account.
Permissions and limits
Account permissions
A GREEN-API 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
The method is used to delete a number from contacts, as well as from the main device's (handset's) phonebook.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete message
Write
The method deletes a message from a chat. To delete a message, you should use the original idMessage.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete products
Write
To use this method, you must have a WhatsApp Business account.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete status
Write
Beta version
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit collection
Write
To use this method, you must have a WhatsApp Business account.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit contact
Write
The method is used to edit a number in contacts, as well as edit a number in the main device's (handset's) phonebook.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit message
Write
The method is editing the text message into a personal or a group chat.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit product
Write
To use this method, you must have a WhatsApp Business account.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Forward messages
Write
The method is intended for forwarding messages to a personal or group chat. The forwarded messages will be added to the send queue. The message will be kept for 24 hours in the queue and will be sent immediately after phone authorization.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get avatar
Read
The method returns a user or a group chat avatar.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get chat history
Read
The method returns the chat message history.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get collection
Read
The method is designed to retrieve information about a specific catalog collection with support for pagination over products within the collection.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get contact information
Read
The method is used to getting information on a contact.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get device information
Read
Attention, please! The method is temporarily not working When the method is called, a 405 error will be returned.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get group data
Read
The method gets group chat data.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get instance settings
Read
The method is used to getting the current instance settings.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get instance state
Read
The method is used to getting the instance state.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get instance state history
Read
The method is used to get the history of the instance state.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get message
Read
The method returns the chat message.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get order details
Read
The method is designed to retrieve detailed information about an order received via the orderMessage webhook.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get product
Read
The method is designed to retrieve information about a specific catalog product by its identifier.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get status statistic
Read
The method returns an array of recipients marked sent/delivered/read for a given status.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Get WhatsApp account information
Read
The method is used to get information about the WhatsApp account
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Leave group
Write
The method makes the current account user leave the group chat.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
List chats
Read
The method is designed to get a list of chats of the current account in chronological order.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List collections
Read
The method is designed to retrieve the list of catalog collections with support for pagination over collections and limiting the number of products within each collection.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List contacts
Read
The method is used to getting a list of the current account contacts.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List incoming calls
Read
Beta version
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List incoming messages
Read
The method returns the last incoming messages of the account. In the default mode the incoming messages for 24 hours are returned.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List incoming statuses
Read
Beta version
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List outgoing calls
Read
Beta version
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List outgoing messages
Read
The method returns the last outgoing messages of the account. In the default mode the last messages for 24 hours are returned.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List outgoing statuses
Read
Beta version
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
List products
Read
The method is designed to retrieve the list of all products from the seller's catalog.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Mark chat as read
Write
The method is used to marking messages in a chat as read. Either all messages or a specified message in a chat can be marked as read.
Permissions and limits
Account permissions
A GREEN-API 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
The method is used to rebooting an instance.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove group admin
Write
The method removes a participant from group chat administration rights.
Permissions and limits
Account permissions
A GREEN-API 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
The method removes a participant from a group chat.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reorder collections
Write
To use this method, you must have a WhatsApp Business account.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send contact
Write
The method is used to sending a contact message. Contact visit card is created and sent to a chat. The message will be added to the send queue. Linked device not required when sending.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send file by URL
Write
The method is used to sending a file uploaded by Url. The message will be added to the send queue. The message will be kept for 24 hours in the queue and will be sent immediately after phone authorization.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send interactive buttons
Write
The method is used to send a message with buttons to personal chats. The method sends buttons to transmit information like links and a phone number to call.
Permissions and limits
Account permissions
A GREEN-API 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
The method is used to sending location message. The message will be added to the send queue. Linked device not required when sending.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send media status
Write
The method is used to sending a pictures or video status. The status will be added to the send queue. Statuses will be kept for 24 hours in the queue until instance will be authorized.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send order (cart)
Write
The method is designed to send an order from a buyer to a store.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send poll
Write
This method is intended for sending messages with a poll to a private or group chat. The message will be added to the send queue. The message is stored for 24 hours in the queue and will be sent immediately after phone authorization.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send product
Write
To use this method, you must have a WhatsApp Business account.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send reply buttons
Write
The method is used to send a message with buttons to personal chats. The method sends buttons that return text to the chat.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send text message
Write
The method is used to sending a text message to a personal or a group chat. The message will be added to the send queue. Linked device not required when sending. Messages will be kept for 24 hours in the queue until instance will be authorized.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send text status
Write
The method is used to sending a text status. The status will be added to the queue. The status will be kept for 24 hours in the queue until instance will be authorized. The rate at which statuses are sent from the queue is managed by Message sending delay parameter.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send typing notification
Write
The method is used to send a notification about typing or recording audio in a chat.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send voice status
Write
The method is used to sending a voice status. The status will be added to the send queue. The status will be kept for 24 hours in the queue until instance will be authorized.
Permissions and limits
Account permissions
A GREEN-API 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
The method is used to changing settings of disappearing messages in chats. The standard settings of the application are to be used: 0 (off), 86400 (24 hours), 604800 (7 days), 7776000 (90 days).
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set group admin
Write
The method sets a group chat participant as an administrator.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Show outgoing queue
Read
The method is used to getting a list of messages in the queue to be sent. Messages will be kept for 24 hours in the queue until instance will be authorized. Messages sending rate is managed by Messages sending delay parameter.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
Unarchive chat
Write
The method unarchives a chat.
Permissions and limits
Account permissions
A GREEN-API instance linked to a WhatsApp account
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update group name
Write
The method changes a group chat name.
Permissions and limits
Account permissions
A GREEN-API 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
Beta version
Permissions and limits
Account permissions
A GREEN-API 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 GREEN-API for WhatsApp. A saved workflow is not a completed provider action.