Skip to content
V2 (Legacy) API ReferenceGet started

Add a participant to a chat

POST/v3/chats/{chatId}/participants

Add a new participant to an existing group chat.

Requirements:

  • Group chats only (3+ existing participants)
  • New participant must support the same messaging service as the group
  • Cross-service additions not allowed (e.g., can’t add RCS-only user to iMessage group)
  • For cross-service scenarios, create a new chat instead
Path ParametersExpand Collapse
chatId: string
formatuuid
Body ParametersJSONExpand Collapse
handle: string

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

ReturnsExpand Collapse
message: optional string
status: optional string
trace_id: optional string

Add a participant to a chat

curl https://api.linqapp.com/api/partner/v3/chats/$CHAT_ID/participants \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY" \
    -d '{
          "handle": "+12052499136"
        }'
{
  "message": "Participant addition 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": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}
Returns Examples
{
  "message": "Participant addition 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": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}