headless lms
Communities

Unlock a chat (staff)

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

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

Staff only (owner, admin, instructor). Lets participants send messages again. Unlocking an unlocked 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/unlock"
{  "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"}

Lock a chat (staff) POST

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

The spaces a member can see in a community GET

GET /api/member/communities/{communityId}/home. The spaces a member can see in a community. Headless LMS Communities API reference.