Mute a chat until a time, or until unmuted

POST /api/member/chats/{chatId}/mute. Mute a chat until a time, or until unmuted. Headless LMS Chats API reference.

For a participant. Without until the chat stays muted until you unmute it.

Path Parameters

chatId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

until?string

When the mute ends. Omit to mute until you unmute

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/api/member/chats/string/mute" \  -H "Content-Type: application/json" \  -d '{}'

null

{  "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"}

Mute a chat until a time, or until unmuted

Path Parameters

Request Body

Response Body

204application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`