Chats

Remove a participant from a chat

Remove a participant from an existing group chat.

Requirements:

  • Group chats only
  • Must have 3+ participants after removal
delete/v3/chats/{chatId}/participants

Request

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

Path parameters

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

Unique identifier of the chat

Request body

handlestring required

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

Example request

{
  "handle": "+12052532136"
}

Response

Participant removal queued successfully

statusstring
trace_idstring
messagestring

Example response

{
  "status": "accepted",
  "message": "Participant removal queued"
}

Changes

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