Matchai Docs

Save a listingComing soon

Saves a published listing. As in the app, the professional who lists it sees that you saved it, and a conversation with them opens so you can ask questions.

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

Coming soon. Saves a published listing. As in the app, the professional who lists it sees that you saved it, and a conversation with them opens so you can ask questions.

Scopes: saved_listings: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: saved_listings: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
listing_id*string

A published listing.

Length1 <= length <= 64

Response Body

The saved listing.

application/json
  1. response
listing*

A short form of a listing, used where listings are embedded in other objects.

professional?|

Who lists it.

saved_at*string

Saved.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/saved-listings' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "listing_id": "string"}'
Example Response
{  "listing": {    "id": "string",    "slug": "string",    "url": "http://example.com",    "title": "string",    "status": "draft",    "availability": "available",    "price": {      "amount": 1,      "currency": "string"    },    "city": "string",    "neighbourhood": "string",    "bedrooms": 0,    "bathrooms": 0,    "cover_image_url": "http://example.com"  },  "professional": {    "username": "string",    "display_name": "string"  },  "saved_at": "2019-08-24T14:15:22Z"}