Matchai Docs

Send a website enquiryComing soon

Records a message someone left on your website.

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

Coming soon. Records a message someone left on your website. Matchai finds the contact by email or phone, or adds them as a lead, files the message and the listing on their record, notifies the account holder and sends lead.created for a new lead. It never writes to the person.

Scopes: contacts:write

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: contacts:write

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

A message someone left on your website. Needs an email or a phone number.

first_name?string

First name.

Length1 <= length <= 100
last_name?string

Last name.

Lengthlength <= 100
email*unknown
phone?string

Phone.

Lengthlength <= 40
message?string

What they wrote.

Length1 <= length <= 4000
listing_id?string

The listing the form was on, if any.

Length1 <= length <= 64
page_url?string

The page the form was on.

Formaturi
language?Locale

A language Matchai publishes in: English (en-US), Québec French (fr-CA) or Spanish (es).

Value in"en-US""fr-CA""es"
consent_to_contact?boolean

They agreed to be contacted. Required true for follow-up by text message.

Response Body

The contact the enquiry was filed on.

application/json
  1. response
contact*

A person in your contacts. Only you (and your team, for team contacts) can see this record; the person cannot.

created*boolean

False when the enquiry was added to an existing contact with the same email or phone.

Example Request
curl -X POST 'https://api.matchai.co/v1/enquiries' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "first_name": "string",  "message": "string",  "email": null}'
Example Response
{  "contact": {    "id": "string",    "type": "lead",    "first_name": "string",    "last_name": "string",    "display_name": "string",    "email": "user@example.com",    "phone": "string",    "company": "string",    "profession": "string",    "notes": "string",    "source": "listing",    "source_listing_id": "string",    "matchai_user": {      "user_id": "string",      "username": "string",      "avatar_url": "http://example.com"    },    "conversation_id": "string",    "erased": true,    "lead": {      "stage": "welcome",      "temperature": "cold",      "readiness": "exploring",      "lifecycle_stage": "new",      "score": 0,      "budget": {        "min": 0,        "max": 0,        "currency": "string"      },      "timeline": "string",      "preferences": {        "bedrooms": 0,        "bathrooms": 0,        "min_sqft": 0,        "max_sqft": 0,        "property_types": [          "string"        ],        "areas": [          "string"        ],        "features": [          "string"        ]      },      "updated_at": "2019-08-24T14:15:22Z"    },    "client": {      "converted_from_lead_at": "2019-08-24T14:15:22Z",      "property_interests": [        "string"      ],      "transactions": [        {          "type": "purchase",          "date": "2019-08-24",          "value": 0,          "listing_id": "string",          "notes": "string"        }      ],      "preferred_channel": "email"    },    "professional": {      "relationship": "peer",      "specializations": [        "string"      ],      "referral_count": 0,      "notes": "string"    },    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "created": true}