UpdateAgentPauseCode

POST

https://api.cbf.tcn.com/api/v0alpha/p3api/updateagentpausecode

Updates an Agent Pause Code with the xml_client_property_sid given on
the pause_code in the request message as defined by the other fields
on the pause_code message.
Required Permissions:
AGENT_MANAGEMENT
Actual permission checked is ORG_EDIT??
Errors:

grpc.InvalidArgument: The pause_code field was not set or the pause_code.codes field was an empty list.

grpc.Internal: an error occurred while marshalling the pause_code into an xml string.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "pause_code": {
        "name": "string",
        "description": "string",
        "codes": [
            "string"
        ],
        "xml_client_property_sid": 0
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/p3api/updateagentpausecode' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pause_code": {
        "name": "string",
        "description": "string",
        "codes": [
            "string"
        ],
        "xml_client_property_sid": 0
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{}

🟢200Success

Modified at 2025-09-26 15:44:58

CreateAgentPauseCode

DeleteAgentPauseCode