Add a Lock to a Specific Conversation
Use the add a lock to a specific conversation request to lock a conversation and prevent it from manual or automated deletion.
Endpoint
Method: POST
URL: /lock
Request Parameter
Parameter Name | Data Type | Description | Required/Optional |
|---|---|---|---|
| String | Enter the category for the lock, at the time of writing this should be | Required |
| String | Enter a description for the lock, a simple explanation of why the conversation is to be locked. | Required |
| String | The ID of the conversation to lock. | Required |
Response and Error Code
Response Code | Condition |
|---|---|
201 | Created |
Response Parameter
Parameter Name | Data Type | Description |
|---|---|---|
| Array | The details of the newly created lock. |
| Integer | The automatically generated ID of the lock, this is used to delete the lock if needed. |
| String | The ID of your tenant. |
| String | The ID of the conversation with the newly created lock, this will match the conversation ID entered in the request body. |
| String | The category of lock, at the time of writing only the default category is available, this will match the |
| String | The description of the lock, (likely a simple explanation of why the conversation is locked), this will match the |
| Date Time | When the conversation was locked, in the format |
| Array | The details of the user that added the lock to the conversation. |
| String | The ID of the user that added the lock to the conversation. |
| String | The email of the user that added the lock to the conversation. |
| String | The full name of the user that added the lock to the conversation. |
| String | The business unit of the user that added the lock to the conversation. |
Sample Request
{
"category": "LOCK_CATEGORY_DEFAULT",
"description": "Ongoing Sale",
"conversationId": "e5a256d5-aad1-4a56-8509-af19df7fe0ef"
}Sample Response
{
"locks": [
{
"id": "3778",
"tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
"conversationId": "e5a256d5-aad1-4a56-8509-af19df7fe0ef",
"category": "LOCK_CATEGORY_DEFAULT",
"description": "Ongoing Sale",
"createdDate": "2024-09-04T13:49:03.033318Z",
"user": {
"userId": "auth0|735ujf53h235bn09835d984h",
"email": "jihn.doe@uniphore.com",
"fullName": "John Doe",
"businessUnit": "Sales"
}
}
]
}