---
title: "UnPause Agent"
method: POST
path: "/api/unpause"
tags: ["Manage Agents"]
---

# UnPause Agent

`POST /api/unpause`

## Request

- Base URL: `https://your-instance.stats.pbx.commpeak.com`
- URL: `https://your-instance.stats.pbx.commpeak.com/api/unpause`
- Auth: API key in header `X-API-KEY`

### UnPause Agent

This endpoint allows you to unpause a specific agent using the following parameters:

- `agent`: (Required) Enter the extension number you wish to unpause.
    
- `format`: The format of the response.
    

### API Response

The response will include the following fields:

- `success`: Indicates the success status of the unpause action.
    
- `message`: Provides additional information or error message related to the unpause action.

## Request body `application/x-www-form-urlencoded`

- object
  - `agent` string
  - `format` string

## Response `200`

successful

- object
  - `message` string
  - `success` string

## Other responses

- `400`: Error: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/commpeak/apis/pbx-stats-api.md) - [All operations](https://skmtc.dev/commpeak/apis/pbx-stats-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/pbx-stats-api/revisions/2f599eb625f8?raw)