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} 
curl -X PUT https://console.trychert.com/api/v1/chats/ch_01H... \
  -H "x-chert-tenant: $TENANT" \
  -H "x-chert-signature: v1,$TS,$SIG" \
  -H "content-type: application/json" \
  -d '{
    "display_name": "Acme launch crew",
    "group_chat_icon": "https://cdn.example.com/acme-icon.png"
  }'

​
Response

{
  "chat": {
    "id": "ch_01H...",
    "display_name": "Acme launch crew",
    "group_chat_icon": "https://cdn.example.com/acme-icon.png",
    "is_group": true
  }
}

​
Path parameters

​
id
string
required
Chat identifier (ch_…).

​
Body

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

​
Response fields

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

​
Errors

CodeHTTPWhen
1004400Invalid JSON body.
1006400Chat is a direct message — only group chats support display name + icon.
2002404Chat not found.
4001502Delivery failed (rename or icon update was rejected).
4099501Group is missing its chat key or has no pinned line.
See the full error code reference.

​
See also