Remove a participant from a chat

chats.participants.remove(, ) -> ParticipantRemoveResponse

DELETE/v3/chats/{chatId}/participants

Remove a participant from an existing group chat.

Requirements:

Group chats only
Must have 3+ participants after removal

ParametersExpand Collapse

chat_id: str

formatuuid

handle: str

Phone number (E.164 format) or email address of the participant to remove

ReturnsExpand Collapse

class ParticipantRemoveResponse: …

message: Optional[str]

status: Optional[str]

trace_id: Optional[str]

Remove a participant from a chat

import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
participant = client.chats.participants.remove(
    chat_id="550e8400-e29b-41d4-a716-446655440000",
    handle="+12052499136",
)
print(participant.trace_id)

{
  "message": "Participant removal 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": "Participant removal 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
}