Chat notifications

POST /v1/chats/:chatId/mute

Turns chat notifications off or back on for the user the call is made on behalf of. Other chat participants are not affected.

Parameters

MUTE with the value "Y" or "N" is accepted instead of mute, as Bitrix24 spells it. Other body fields are not forwarded.

Examples

curl — personal key

curl -X POST https://vibecode.bitrix24.com/v1/chats/456/mute \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mute": false}'

curl — OAuth application

curl -X POST https://vibecode.bitrix24.com/v1/chats/456/mute \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mute": false}'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/456/mute', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ mute: false }),
})

const { success, data } = await res.json()

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/456/mute', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ mute: false }),
})

const { success, data } = await res.json()

Response fields

Response example

{
  "success": true,
  "data": {
    "chatId": 456,
    "muted": false
  }
}

Error response example

400 — the body has no mute field:

{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Body field `mute` (boolean) is required: true switches the chat notifications off, false switches them back on."
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

The setting is personal. Notifications change only for the user the call is made on behalf of. With a personal key, that is the key owner. To change the setting for an employee who opened your application, call the endpoint with the application key and that employee's vibe_session_* session in the Authorization header, as in the OAuth application examples. An administrator key cannot turn notifications off on someone else's behalf.

An employee session lasts 24 hours. A vibe_session_* session appears when the employee opens the application and stays valid for a day. If your application reacts to a Bitrix24 event, such as an observer being added to a task, an employee who has not opened the application recently has no valid session, and a call on their behalf fails. Change the setting at the moment the employee opens the application.

mute is required. The field is never guessed: a request without it is refused before the Bitrix24 call. This way a request that lost the field does not turn notifications off when it meant to turn them on.

See also

• Leave a chat
• Find a CRM entity chat
• Chat management