API Reference

Chats

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

client.Chats.Participants.Add(ctx, chatID, body) (*ChatParticipantAddResponse, error)

POST/v3/chats/{chatId}/participants

Remove a participant from a chat

client.Chats.Participants.Remove(ctx, chatID, body) (*ChatParticipantRemoveResponse, error)

DELETE/v3/chats/{chatId}/participants