Manage Agents
Edit Agent
Edit Agent Details
This endpoint allows you to edit agent details.
Request Body
-
userExtension (Required) - The extension number to dial to reach this user.
-
displayName (Required) - The CallerID name for calls from this user will be set to this name. Only enter the name, NOT the number.
-
format - The format of the response.
-
desksName - Desks names to add, can add more than one (e.g., desk1, desk2, desk3).
Response
-
success - Indicates the success status of the request.
-
message - Provides additional information or error message.
Example
{
"success": "",
"message": ""
}
post/api/editAgent
Request
- Base URLhttps://your-instance.stats.pbx.commpeak.com
- URLhttps://your-instance.stats.pbx.commpeak.com/api/editAgent
- AuthAPI key in header X-API-KEY
Request body application/x-www-form-urlencoded
Example request
{
"desksName": "<string>",
"displayName": "<string>",
"format": "json",
"userExtension": "<number>"
}Response
successful
Example response
{
"message": "<string>",
"success": "<boolean>"
}Changes
No recorded changes to this operation across all 1 revision of this API.