Skip to main content
Auth. HMAC v1 or bearer token — see Authentication. Status. Live · Idempotent: No (removing the same address twice yields a “not in group” error).
Removes a participant from an iMessage group chat. The address path parameter is URL-encoded (E.164 phone or email). Apple enforces a minimum group size of 3 — removals that would shrink the group below 3 are rejected with 1002.

Request

DELETE /api/v1/chats/{id}/participants/{address}

Response

Path parameters

string
required
Chat identifier (ch_…).
string
required
URL-encoded E.164 phone number or email of the participant to remove.

Response fields

string
The chat the participant was removed from.
string
The address that was removed.
string[]
Full participant roster after the remove.

Errors

See the full error code reference.

See also