Blocks a client based on the thread ID in edna Chat Center or the client’s external ID. You must specify either one of the parameters: threadId or externalClientId.
Permissions
---- Permissions:INTEGRATOR,OPERATOR,SUPERVISOR ----
Request Parameters
| Parameter | Type | Description |
threadId | long | Internal thread ID in edna Chat Center |
externalClientId | string | Client ID in an external system |
reason | string | Block reason |
HTTP Request
PUT /api/v1/clients/block HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 84
Host: localhost: 8080
{
"threadId": 1,
"externalClientId": null,
"reason": "Client blocked"
}
Example of a Successful HTTP Response
HTTP/1.1 200 OK Vary: Origin Vary: Access-Control-Request-Method Vary: Access-Control-Request-Headers