Leave a group chat

client.chats.leaveChat(, ?): ChatLeaveChatResponse { message, status, trace_id }

POST/v3/chats/{chatId}/leave

Removes your phone number from a group chat. Once you leave, you will no longer receive messages from the group and all interaction endpoints (send message, typing, mark read, etc.) will return 409.

A participant.removed webhook will fire once the leave has been processed.

Supported

iMessage group chats with 4 or more active participants (including yourself)

Not supported

DM (1-on-1) chats — use the chat directly to continue the conversation

ParametersExpand Collapse

chatID: string

formatuuid

ReturnsExpand Collapse

ChatLeaveChatResponse { message, status, trace_id }

message?: string

status?: string

trace_id?: string

Leave a group 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 response = await client.chats.leaveChat('550e8400-e29b-41d4-a716-446655440000');

console.log(response.trace_id);

{
  "message": "Leave group chat queued",
  "status": "accepted",
  "trace_id": "trace_id"
}

{
  "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": 409,
    "code": 2013,
    "message": "This chat is unavailable"
  }
}

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

Returns Examples

{
  "message": "Leave group chat queued",
  "status": "accepted",
  "trace_id": "trace_id"
}

{
  "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": 409,
    "code": 2013,
    "message": "This chat is unavailable"
  }
}

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