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 
curl -X POST https://console.trychert.com/api/v1/chats/ch_01H.../participants \
  -H "x-chert-tenant: $TENANT" \
  -H "x-chert-signature: v1,$TS,$SIG" \
  -H "content-type: application/json" \
  -d '{"address": "+14155551234"}'

​
Response

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

​
Path parameters

​
id
string
required
Chat identifier (ch_…).

​
Body

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

​
Response fields

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

​
Errors

CodeHTTPWhen
1001400address missing.
1006400Chat is a direct message — participants endpoint only applies to groups.
2002404Chat not found.
4001502Delivery failed (add participant was rejected).
4099422Group is missing its chat key or has no pinned line.
See the full error code reference.

​
See also