Matchai Docs

Add someone to a group conversationComing soon

Adds one of your contacts to a group conversation you own or administer. They are notified and can read its history.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/conversations/{conversation_id}/participants

Coming soon. Adds one of your contacts to a group conversation you own or administer. They are notified and can read its history.

Final action. When the connection is set to Ask me, this call returns 202 with an approval_url and does nothing until the account holder approves it in Matchai; Matchai then performs it exactly as sent and sends approval.resolved. When the connection is set to Allowed, it runs straight away.

Scopes: messages:send

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: messages:send

Path Parameters

conversation_id*string

Conversation id.

Length1 <= length <= 64

Header Parameters

Idempotency-Key?string

A unique string (a UUID works). Retrying with the same key within 24 hours returns the first response instead of acting twice. Reusing a key with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 255

Request Body

application/json
  1. body
contact_id*string

A contact to add to a group conversation you own or administer. They will see the conversation’s history.

Length1 <= length <= 64

Response Body

Participants, with the new one.

application/json
  1. response
data*array<>

Everyone in the conversation.

Example Request
curl -X POST 'https://api.matchai.co/v1/conversations/string/participants' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "contact_id": "string"}'
Example Response
{  "data": [    {      "user_id": "string",      "contact_id": "string",      "display_name": "string",      "avatar_url": "http://example.com"    }  ]}