Overview You can customize various settings for your WhatsApp instance, including call handling, message reading behavior, and history synchronization.
These settings apply to the entire instance and affect how your WhatsApp bot behaves.
Authentication This endpoint requires authentication via the apikey header.
Your Evolution API key for authentication.
Path Parameters The name of your WhatsApp instance.
Request Body Automatically reject incoming calls.
Message to send when a call is rejected (only used if rejectCall is true).
Ignore messages from groups (don’t trigger webhooks or chatbot responses).
Keep the instance status as “online” at all times.
Automatically mark all incoming messages as read.
Automatically read status updates from contacts.
Synchronize full message history when connecting (may take longer to connect).
Token for VOIP integration (advanced feature).
Response The updated settings object. Message sent on call rejection.
Group message ignore status.
Auto-read messages status.
Auto-read status updates.
Full history sync status.
curl --request POST \ --url https://api.example.com/settings/set/my-instance \ --header 'apikey: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "rejectCall": true, "msgCall": "Sorry, I cannot take calls at the moment. Please send a message.", "groupsIgnore": false, "alwaysOnline": true, "readMessages": true, "readStatus": false, "syncFullHistory": false }'
201 Success
400 Bad Request
401 Unauthorized
404 Not Found
{ "settings" : { "instanceId" : "my-instance" , "rejectCall" : true , "msgCall" : "Sorry, I cannot take calls at the moment. Please send a message." , "groupsIgnore" : false , "alwaysOnline" : true , "readMessages" : true , "readStatus" : false , "syncFullHistory" : false } }
Setting Details Call Rejection When enabled, all incoming voice and video calls are automatically rejected. Useful for chatbot instances that should only handle text messages.
Customize the message sent when rejecting calls. This helps inform callers why their call was rejected and what they should do instead.
Message Handling readMessages
groupsIgnore
Automatically marks all incoming messages as read. The sender will see blue checkmarks immediately.
When enabled, messages from groups won’t trigger webhooks or chatbot responses. Useful when you want to handle only individual chats.
Presence and Status Keeps your instance showing as “online” continuously. Useful for bot accounts to appear always available.
Automatically views status updates posted by your contacts. They will see that you viewed their status.
History Synchronization When enabled, the instance will download and sync complete message history on first connection. This may significantly increase connection time but ensures all historical data is available.
Usage Notes For chatbot instances, consider enabling rejectCall, alwaysOnline, and readMessages for the best user experience.
Enabling syncFullHistory can significantly slow down instance connection, especially for accounts with large message histories.
You can update settings at any time without needing to restart the instance. Changes take effect immediately.
Get Current Settings To retrieve current settings:
GET /settings/find/:instanceName
This returns the current configuration for your instance.
curl --request GET \ --url https://api.example.com/settings/find/my-instance \ --header 'apikey: YOUR_API_KEY'