Skip to main content

Uniphore Customer Portal

Remove Locks in Bulk

Use the bulk delete locks request to remove locks from multiple conversations with one request, allowing for those conversations to be manually or automatically deleted.

Endpoint

Method: POST

URL: /lock/bulk_remove

Request Parameter

Parameter Name

Data Type

Description

Required/Optional

conversationLocks

Array

List the conversations and associated locks to remove, each consisting of the following parameters in this table.

Required

conversationIds

String

The ID of the conversation with the lock to remove.

Required

lockId

Number

The ID of the lock to remove.

Required

Sample Request
{
    "conversationLocks": [
        {
            "conversationId": "e5a256d5-aad1-4a56-8509-af19df7fe0ef",
            "lockId": 3870
        },
        {
            "conversationId": "f3e99e8e-303d-4ed9-80bb-5d18ac07a4db",
            "lockId": 3869
        }
    ]
}
Response and Error Code

Response Code

Condition

200

Ok

The above 200 Ok response means that the locks have been deleted, you can always get the lock information for a specific conversation and confirm that locks have been removed using this request, the response of a conversation without a lock will be blank.

In this section: