Session Rate Limits
View available rate-limit policies and the current policy for an instance. Paid users can select any policy; free users are limited to strict and standard policies.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Start with the 'strict' policy for new numbers, then gradually relax to 'standard' after warming up.
Re-check the policy after a restart using GET /v2/session/rate-limit.
Session Rate Limits: /v2/session/rate-limit
Use this endpoint to inspect and change the sending policy applied to a WhatsApp session. Policies control message throughput, daily caps, safety intervals, and group/contact discovery limits to reduce the risk of account bans.
Free vs Paid Policies
- Free users can only use the free policies returned in
free_policies(typicallystrictandstandard_policy). - Paid users (
has_active_plan: true) can use any policy in thepolicieslist, including high-throughput and unlimited options.
Each policy includes a limits object with fields such as:
send_message_per_minutesend_message_daily_capaccount_protection_secondsconcurrent_limitgroup_req_per_minute/group_daily_capcheck_req_per_minute/check_daily_cap
How to Update the Policy
- Call
GET /v2/session/rate-limitto see the current policy and available options. - Choose a policy whose
availableflag istrue. - Call
PATCH /v2/session/rate-limitwith the selectedpolicy_slug.
The policy is saved in both the application database and the engine metadata so it remains active after restarts.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
URL Parameters
Passed in the URL query stringstring | The 12-character ID of the instance Example: | ||
string | Your API Access Token Example: | ||
string | — | The slug of the policy to apply (required for PATCH). Must be available for the user's plan. Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"status": "success",
"current_policy": "standard_policy",
"has_active_plan": false,
"free_policies": {
"0": "strict",
"1": "standard_policy"
},
"policies": {
"0": {
"id": 1,
"name": "Strict",
"slug": "strict",
"description": "Conservative limits for fresh or sensitive accounts.",
"limits": {
"send_message_per_minute": 8,
"send_message_daily_cap": 200,
"account_protection_seconds": 60,
"concurrent_limit": 1
},
"available": true
}
}
}Command Palette
Search for a command to run...