Chats

Update a chat

Update chat properties such as display name and group chat icon.

Listen for chat.group_name_updated, chat.group_icon_updated, chat.group_name_update_failed, or chat.group_icon_update_failed webhook events to confirm the outcome.

put/v3/chats/{chatId}

Request

  • Base URL: https://api.linqapp.com/api/partner
  • URL: https://api.linqapp.com/api/partner/v3/chats/{chatId}
  • Auth: HTTP bearer

Path parameters

chatIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Unique identifier of the chat

Request body

display_namestring

New display name for the chat (group chats only)

group_chat_iconstring uri

URL of an image to set as the group chat icon (group chats only)

Example request

{
  "display_name": "Updated Team Name",
  "group_chat_icon": "https://example.com/icon.png"
}

Response

Update request accepted and queued for processing

statusstring
chat_idstring uuid

Example response

{
  "status": "pending",
  "chat_id": "550e8400-e29b-41d4-a716-446655440000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.