Matchai Docs

Draft an email with AIComing soon

Writes an email to a contact for a person to review. It sends nothing.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/email-drafts

Coming soon. Writes an email to a contact for a person to review. It sends nothing.

Spends Matchai Energy. Returns 402 without doing anything when the account does not have enough Energy, or when this connection reached the Energy limit the account holder set for it.

Scopes: messages:read and contacts:read

Pricing: Included with the connection, and spends Matchai Energy.

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:read, contacts:read

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

The recipient.

Length1 <= length <= 64
about*string

What to say, plainly.

Length1 <= length <= 1000
tone?string

For example "warm" or "brief".

Lengthlength <= 40
listing_id?string

A listing it is about.

Length1 <= length <= 64

Response Body

The draft.

application/json
  1. response

Text for a person to review. Nothing was sent.

subject?|

Subject line, for an email draft.

text*string

The draft.

Example Request
curl -X POST 'https://api.matchai.co/v1/email-drafts' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "contact_id": "string",  "about": "string"}'
Example Response
{  "subject": "string",  "text": "string"}