> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hypersender.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Restart Instance

> Restart a WhatsApp instance to resolve connection issues or refresh its state.

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

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

## 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
```

<Tip>
  If the restart fails with a 500 error, try restarting the instance manually from the Hypersender dashboard or contact support if the issue persists.
</Tip>

## 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.**


## OpenAPI

````yaml v1/api-reference/enterprise/enterprise-collection.json POST /{instance}/restart
openapi: 3.1.0
info:
  version: v1.0
  title: Hypersender Enterprise API Docs
  description: >

    The Hypersender Enterprise API provides powerful management capabilities for
    WhatsApp instances.


    In this Docs you'll learn how to use and integrate Hypersender Enterprise
    API into your existing system/service or application using simple API
    endpoints.


    **What you can Do?**


    - Check instance health status

    - List all instances with filtering

    - Create new WhatsApp instances

    - Request new QR codes for authentication

    - Restart instances


    <hr />


    ## Servers (Endpoints)


    - Production (activated):
    [https://app.hypersender.com/api/whatsapp/v1](https://app.hypersender.com/api/whatsapp/v1)
servers:
  - url: https://app.hypersender.com/api/whatsapp/v1
    description: Production
security:
  - Authorization: []
paths:
  /{instance}/restart:
    post:
      tags:
        - Instance Management
      summary: Restart Instance
      description: >-
        Restarts a WhatsApp instance. Useful when the instance is stuck or not
        working properly. This endpoint is limited to 5 requests per minute.
      parameters:
        - name: Accept
          in: header
          description: application/json
          schema:
            type: string
            example: application/json
        - name: instance
          in: path
          description: Instance UUID copied from hypersender dashboard
          required: true
          schema:
            type: string
            example: '{{ instance_id }}'
      responses:
        '200':
          description: Instance restarted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: WhatsApp instance restarted successfully.
        '404':
          description: Instance not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests. Please try again later.
        '500':
          description: Failed to restart instance
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: >-
                      Failed to restart WhatsApp instance. Please try restarting
                      the instance from hypersender dashboard.
      security:
        - Authorization: []
components:
  schemas:
    NotFoundError:
      type: object
      title: NotFoundError
      example:
        message: Resource not found.
      properties:
        message:
          type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Bearer token authentication. Example: `Bearer
        234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1`

````