Skip to main content
Auth. HMAC v1 or bearer token — see Authentication. Status. Live · Idempotent: Effectively yes — adding the same address twice is a no-op.
Adds a phone number or email handle to an existing iMessage group chat. The line pinned to this chat handles the operation. Direct messages return 1006.

Request

POST /api/v1/chats/{id}/participants

Response

Path parameters

string
required
Chat identifier (ch_…).

Body

string
required
E.164 phone number or email address to add to the group. handle is accepted as an alias.

Response fields

string
The chat the participant was added to.
string
The address that was added (echoed back, normalized).
string[]
Full participant roster after the add.

Errors

See the full error code reference.

See also