Matchai Docs

Add a listing to a site, or feature itComing soon

Puts a published listing on the site, or changes whether it is featured. Taking a listing off a site changes nothing about the listing itself.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
PUT
/sites/{site_id}/listings/{listing_id}

Coming soon. Puts a published listing on the site, or changes whether it is featured. Taking a listing off a site changes nothing about the listing itself.

Scopes: sites: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: sites:write

Path Parameters

site_id*string

Site id.

Length1 <= length <= 64
listing_id*string

Listing id, or its slug.

Length1 <= length <= 200

Request Body

application/json
  1. body
featured?boolean

Feature it on the site. Left as it is when omitted.

Response Body

The listing on the site.

application/json
  1. response
listing*

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

featured*boolean

Featured on the site.

position*integer

Order on the site, from 0.

Range0 <= value
added_at*string

Added to the site.

Formatdate-time
Example Request
curl -X PUT 'https://api.matchai.co/v1/sites/string/listings/string' \  -H 'Content-Type: application/json' \  -d '{}'
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"  },  "featured": true,  "position": 0,  "added_at": "2019-08-24T14:15:22Z"}