Skip to main content

Uniphore Customer Portal

Add Locks in Bulk

Use the bulk add locks request to add locks from multiple conversations with one request, preventing those conversations from manual or automated deletion.

Endpoint

Method: POST

URL: /lock/bulk_add

Request Parameter

Parameter Name

Data Type

Description

Required/Optional

lockDescription

String

Enter a description for the locks, a simple explanation of why the conversations are to be locked.

Required

conversationIds

Array

Add a list of the conversation IDs for the conversations to lock, in order to prevent manual or automated deletion.

Required

Sample Request
{
    "lockDescription": "Ongoing Sale",
    "conversationIds": [
        "f3e99e8e-303d-4ed9-80bb-5d18ac07a4db",
        "e5a256d5-aad1-4a56-8509-af19df7fe0ef"
    ]
}
Response and Error Code

Response Code

Condition

201

Created