headless lms
Communities

Lock a chat (staff)

POST /api/communities/{communityId}/chats/{chatId}/lock. Lock a chat (staff). Headless LMS Communities API reference.

POST
/api/communities/{communityId}/chats/{chatId}/lock

Staff only (owner, admin, instructor). Nobody can send or edit messages until it is unlocked; its open message flags are resolved as locked. Locking a locked chat returns it unchanged.

Path Parameters

communityId*string
chatId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/communities/string/chats/string/lock"
{  "orgId": "string",  "id": "string",  "communityId": "string",  "kind": "direct",  "status": "pending",  "createdBy": "string",  "lockedAt": "2019-08-24T14:15:22Z",  "lockedBy": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}

Dismiss the open flags on a message (staff) POST

POST /api/communities/{communityId}/messages/{messageId}/flags/resolution. Dismiss the open flags on a message (staff). Headless LMS Communities API reference.

Unlock a chat (staff) POST

POST /api/communities/{communityId}/chats/{chatId}/unlock. Unlock a chat (staff). Headless LMS Communities API reference.