Skip to main content
POST
/
{instance}
/
restart
Restart Instance
curl --request POST \
  --url https://app.hypersender.com/api/whatsapp/v1/{instance}/restart \
  --header 'Authorization: Bearer <token>'
{
  "message": "WhatsApp instance restarted successfully."
}
Restart a WhatsApp instance when it’s stuck, not responding properly, or experiencing connection issues. This endpoint performs a clean restart of the instance.

​
Rate Limit

This endpoint is limited to 5 requests per minute to prevent abuse and ensure system stability.

​
When to Use

Restart your instance when:
  • The instance is stuck in a STARTING or PENDING state
  • Messages are not being sent or received
  • The instance is not responding to health checks
  • After extended periods of inactivity
  • When experiencing unexplained connection issues

​
Response

Upon successful restart:
  • 200 OK: Instance restarted successfully
  • The instance will go through the startup sequence
  • Status will transition: STOPPED → STARTING → WORKING

​
Important Notes

Restarting an instance will temporarily interrupt message sending and receiving. Plan restarts during low-activity periods if possible.

​
Restart Process

  1. Send restart request
  2. Instance stops current operations
  3. Instance begins startup sequence
  4. Connection is re-established
  5. Instance returns to WORKING status

​
Monitoring After Restart

After restarting an instance, monitor its status: 
1. Call restart endpoint
2. Wait 5-10 seconds
3. Use Check Instance Health endpoint
4. Verify status is WORKING
If the restart fails with a 500 error, try restarting the instance manually from the Hypersender dashboard or contact support if the issue persists.

​
Error Responses

  • 404: Instance not found - Verify the instance UUID is correct
  • 429: Rate limit exceeded - Wait before attempting another restart
  • 500: Failed to restart instance - Try manual restart from dashboard or contact support

​
Alternative

If the API restart fails, you can always restart the instance manually from the Hypersender dashboard as a fallback option.

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Example: Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1

Headers

​
Accept
string

application/json

Example:

"application/json"

Path Parameters

​
instance
string
required

Instance UUID copied from hypersender dashboard

Example:

"{{ instance_id }}"

Response

Instance restarted successfully

​
message
string
Example:

"WhatsApp instance restarted successfully."