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} 
curl -X DELETE \
  "https://console.trychert.com/api/v1/chats/ch_01H.../participants/%2B14155551234" \
  -H "x-chert-tenant: $TENANT" \
  -H "x-chert-signature: v1,$TS,$SIG"

​
Response

{
  "chat_id": "ch_01H...",
  "removed": "+14155551234",
  "participants": ["+14155550100", "+14155550200"]
}

​
Path parameters

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

​
Response fields

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

​
Errors

CodeHTTPWhen
1001400address missing or not in the group.
1002400Group is at the minimum size of 3 — cannot shrink further.
1006400Chat is a direct message.
2002404Chat not found.
4001502Delivery failed.
4099422Group is missing its chat key or has no pinned line.
See the full error code reference.

​
See also