---
title: "Pause Agent"
method: POST
path: "/api/pause"
tags: ["Manage Agents"]
---

# Pause Agent

`POST /api/pause`

## Request

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

### Pause Agent

This endpoint allows you to pause an agent by providing the extension number and the pause type ID.

#### Request Body

- `agent` (text, required): Enter the extension number you wish to pause.
    
- `format` (text): The format of the response.
    
- `pauseId` (text, required): Enter the ID of the Pause type. You can get the full list of pauses for your account by using the “PausesList” API method.
    

#### Response

The response will be in JSON format with the following fields:

- `success`: Indicates the success of the pause action.
    
- `message`: Provides additional information about the pause action.
    

#### Example

``` json
{
    "success": "",
    "message": ""
}

 ```

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

- object
  - `agent` string
  - `format` string
  - `pauseId` 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)