Skip to content
V2 (Legacy) API ReferenceGet started

Participants

A Chat is a conversation thread with one or more participants.

To begin a chat, you must create a Chat with at least one recipient handle. Including multiple handles creates a group chat.

When creating a chat, the from field specifies which of your authorized phone numbers the message originates from. Your authentication token grants access to one or more phone numbers, but the from field determines the actual sender.

Handle Format:

  • Handles can be phone numbers or email addresses
  • Phone numbers MUST be in E.164 format (starting with +)
  • Phone format: +[country code][subscriber number]
  • Example phone: +12223334444 (US), +442071234567 (UK), +81312345678 (Japan)
  • Example email: [email protected]
  • No spaces, dashes, or parentheses in phone numbers
Add a participant to a chat
POST/v3/chats/{chatId}/participants
Remove a participant from a chat
DELETE/v3/chats/{chatId}/participants
ModelsExpand Collapse
ParticipantAddResponse object { message, status, trace_id }
message: optional string
status: optional string
trace_id: optional string
ParticipantRemoveResponse object { message, status, trace_id }
message: optional string
status: optional string
trace_id: optional string