Skip to main content
Auth. HMAC v1 or bearer token — see Authentication. Status. Live · Idempotent: Yes (last write wins).
Renames a group chat or sets its group icon. Supplying both fields in one call applies both. The line pinned to this chat handles the operation. Direct messages do not support these fields and return 1006.

Request

PUT /api/v1/chats/{id}

Response

Path parameters

string
required
Chat identifier (ch_…).

Body

string
New display name for the group. Trimmed; must be non-empty if present.
string
HTTPS URL of the new group icon image.

Response fields

object
Refreshed chat object with the updated display_name and group_chat_icon fields.

Errors

See the full error code reference.

See also