Matchai Docs

Add a roomComing soon

Adds a room, with its size and floor when you know them. Adding a bedroom or a bathroom raises the listing’s count to match.

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

Coming soon. Adds a room, with its size and floor when you know them. Adding a bedroom or a bathroom raises the listing’s count to match.

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

Path Parameters

listing_id*string

Listing id, or its slug.

Length1 <= length <= 200

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

Give dimension_unit whenever you give a width or a depth. Québec plans usually give metres.

type*string

A space type key from GET /space-types.

Length1 <= length <= 60
name?string

Name.

Length1 <= length <= 120
floor_level?string

Storey.

Length1 <= length <= 40
width?number

Width.

Range0.5 <= value <= 500
depth?number

Depth.

Range0.5 <= value <= 500
dimension_unit?DimensionUnit
Value in"feet""meters"
flooring?string

Floor covering.

Lengthlength <= 60
notes?string

Note.

Lengthlength <= 500

Response Body

The new room.

application/json
  1. response

A room or space of the property.

id*string

Space id.

Length1 <= length <= 64
listing_id*string

Listing id.

Length1 <= length <= 64
type*string

A space type key from GET /space-types, for example bedroom.

name?|

Name, for example "Primary bedroom".

floor_level?|

Storey, for example "Ground" or "2nd".

width?|

Width, in dimension_unit.

depth?|

Depth, in dimension_unit.

dimension_unit?|null
flooring?|

Floor covering, for example "Hardwood".

notes?|

Short note about the room.

position*integer

Order on the listing page.

Range0 <= value
Example Request
curl -X POST 'https://api.matchai.co/v1/listings/string/spaces' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "type": "string"}'
Example Response
{  "id": "string",  "listing_id": "string",  "type": "string",  "name": "string",  "floor_level": "string",  "width": 0,  "depth": 0,  "dimension_unit": "feet",  "flooring": "string",  "notes": "string",  "position": 0}