[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-chats\u002Fmanagement\u002Fdescription":3,"docs-tabs-chats\u002Fmanagement\u002Fdescription":6},{"content":4,"lastmod":5},"## Change a chat description\n\n`PUT \u002Fv1\u002Fchats\u002F:dialogId\u002Fdescription`\n\nReplaces the chat description with the text from the request. An empty string clears the description.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|---------|\n| `dialogId` (path) | string | yes | Dialog ID: `chatXXX` for a group chat, a numeric user ID for private messages, `me` — the current user's personal dialog. A CRM entity chat is found via [Find a CRM entity chat](\u002Fdocs\u002Fchats\u002Fdiscovery\u002Ffind) |\n\nThe endpoint takes no query parameters: any parameter in the query string is refused with `400 INVALID_PARAMS`.\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|---------|\n| `description` | string | yes | The new description. Bitrix24 trims leading and trailing spaces. An empty string `\"\"` clears the description |\n\nOther body fields are refused with `400 INVALID_PARAMS`, and the message names the extra field.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X PUT https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fchats\u002Fchat2741\u002Fdescription \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"description\": \"Warehouse equipment purchase\"}'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X PUT https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fchats\u002Fchat2741\u002Fdescription \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"description\": \"Warehouse equipment purchase\"}'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fchats\u002Fchat2741\u002Fdescription', {\n  method: 'PUT',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ description: 'Warehouse equipment purchase' }),\n})\n\nconst { success } = await res.json()\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fchats\u002Fchat2741\u002Fdescription', {\n  method: 'PUT',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ description: 'Warehouse equipment purchase' }),\n})\n\nconst { success } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | Always `true` on success |\n| `data` | boolean | `true` — the description is saved |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": true\n}\n```\n\n## Error response example\n\n400 — the body has no `description` field:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Body field `description` must be a string — the new description; an empty string clears it.\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | The body has no `description` or it is not a string, the body has another field, the body is not a JSON object, or the query string has a parameter. Checked before the Bitrix24 call |\n| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 refused: the user is not a chat member, or the `ui` permission does not let them change the description |\n| 422 | `BITRIX_ERROR` | Bitrix24 returned an error; the portal code is in `error.b24Code`. If the chat does not exist, the code is `CHAT_NOT_FOUND` |\n| 403 | `SCOPE_DENIED` | The API key lacks the `im` scope |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only — changing the description counts as a write |\n| 401 | `TOKEN_MISSING` | The API key has no configured Bitrix24 tokens |\n| 502 | `ME_ALIAS_RESOLUTION_FAILED` | `dialogId=me` — the current user's ID could not be resolved |\n| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable or returned a server error |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**Current description.** The saved text comes in the `description` field of the [Dialog details](\u002Fdocs\u002Fchats\u002Fdiscovery\u002Fget) response. Changing the description does not post a system message to the chat.\n\n**Who can change the description.** Users allowed by the `ui` permission can change a chat's description, color and avatar. [`PUT \u002Fv1\u002Fchats\u002F:dialogId\u002Fpermissions\u002Fui`](\u002Fdocs\u002Fchats\u002Fmanagement\u002Fpermissions-ui) sets who holds it, and the `permissions.manageUi` field of the [Dialog details](\u002Fdocs\u002Fchats\u002Fdiscovery\u002Fget) response shows the current value.\n\n## See also\n\n- [Rename a chat](\u002Fdocs\u002Fchats\u002Fmanagement\u002Frename)\n- [Change a chat color](\u002Fdocs\u002Fchats\u002Fmanagement\u002Fcolor)\n- [Change a chat avatar](\u002Fdocs\u002Fchats\u002Fmanagement\u002Favatar)\n- [Set the permission to change chat appearance](\u002Fdocs\u002Fchats\u002Fmanagement\u002Fpermissions-ui)\n- [Dialog details](\u002Fdocs\u002Fchats\u002Fdiscovery\u002Fget)\n","2026-10-05",{},1794739539254]