Matchai Docs

Update lead detailsComing soon

Moves a lead through your pipeline or records their budget and preferences.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
PATCH
/contacts/{contact_id}/lead-details

Coming soon. Moves a lead through your pipeline or records their budget and preferences.

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

Path Parameters

contact_id*string

Contact id.

Length1 <= length <= 64

Request Body

application/json
  1. body
Properties1 <= properties
stage?string
Value in"welcome""nurture""activate""qualify""ready""handed_off"
temperature?string
Value in"cold""cool""warm""hot""burning"
readiness?string
Value in"exploring""interested""considering""deciding""committed"
budget?|null
timeline?|

In words.

Lengthlength <= 200
preferences?

What the lead is looking for.

Response Body

Lead details.

application/json
  1. response

Where a lead stands in your pipeline.

stage*string

Pipeline stage.

Value in"welcome""nurture""activate""qualify""ready""handed_off"
temperature*string
Value in"cold""cool""warm""hot""burning"
readiness*string
Value in"exploring""interested""considering""deciding""committed"
lifecycle_stage*string
Value in"new""returning""referral""reactivated"
score?|

Lead score, 0 to 100.

Range0 <= value <= 100
budget?|null
timeline?|

When they want to move, in words.

preferences?

What the lead is looking for.

updated_at?string

Last changed.

Formatdate-time
Example Request
curl -X PATCH 'https://api.matchai.co/v1/contacts/string/lead-details' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "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"}