Update a chat

client.chats.update(, , ?): ChatUpdateResponse { chat_id, status }

PUT/v3/chats/{chatId}

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.

ParametersExpand Collapse

chatID: string

formatuuid

body: ChatUpdateParams { display_name, group_chat_icon }

display_name?: string

New display name for the chat (group chats only)

group_chat_icon?: string

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

formaturi

ReturnsExpand Collapse

ChatUpdateResponse { chat_id, status }

chat_id?: string

formatuuid

status?: string

Update a chat

import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const chat = await client.chats.update('550e8400-e29b-41d4-a716-446655440000', {
  display_name: 'Team Discussion',
});

console.log(chat.chat_id);

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

{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format"
  },
  "success": false
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}

Returns Examples

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

{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format"
  },
  "success": false
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}