Chats

Leave a group chat

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
post/v3/chats/{chatId}/leave

Request

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

Path parameters

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

Unique identifier of the chat to leave

Response

Leave group chat request queued successfully

statusstring
trace_idstring
messagestring

Example response

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

Changes

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