COcommpeak
Manage Agents

Delete Agent

Delete Agent API

This API endpoint is used to delete an agent.

Request Body

  • userExtension (text, required): The extension number to dial to reach this user.

  • format (text): The format of the response.

Response

The response for this request is a JSON object with the following properties:

  • success (string): Indicates the success status of the operation.

  • message (string): Provides additional information or error message.

Example

{
    "success": "",
    "message": ""
}
post/api/deleteAgent

Request

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

Request body application/x-www-form-urlencoded

formatstring
userExtensionstring

Example request

{
  "format": "json",
  "userExtension": "<number>"
}

Response

successful

messagestring
successstring

Example response

{
  "message": "<string>",
  "success": "<boolean>"
}

Changes

No recorded changes to this operation across all 1 revision of this API.