curl --fail-with-body -X PATCH https://maatstays.wtf/v1/units/8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804 \
-H "Authorization: Bearer $MAAT_PARTNER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"max_guests": 5, "beds": 4, "check_in_time": "15:00"}'// Partial: an absent field is untouched. Send at least one.
const res = await fetch(
'https://maatstays.wtf/v1/units/8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804',
{
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.MAAT_PARTNER_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ max_guests: 5, beds: 4, check_in_time: '15:00' }),
},
);
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.detail}`);
console.log(body.max_guests, body.beds, body.check_in_time);
import os
import requests
# Partial: an absent field is untouched. Send at least one.
res = requests.patch(
"https://maatstays.wtf/v1/units/8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804",
headers={"Authorization": f"Bearer {os.environ['MAAT_PARTNER_TOKEN']}"},
json={"max_guests": 5, "beds": 4, "check_in_time": "15:00"},
timeout=30,
)
body = res.json()
if res.status_code >= 400:
raise RuntimeError(f"{body['code']}: {body.get('detail')}")
print(body["max_guests"], body["beds"], body["check_in_time"])
package main
import (
"bytes"
"encoding/json"
"fmt"
"log"
"net/http"
"os"
)
type unit struct {
MaxGuests int `json:"max_guests"`
Beds int `json:"beds"`
}
func main() {
// Partial: an absent field is untouched. Send at least one.
payload, _ := json.Marshal(map[string]any{
"max_guests": 5,
"beds": 4,
"check_in_time": "15:00",
})
req, _ := http.NewRequest(http.MethodPatch,
"https://maatstays.wtf/v1/units/8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804",
bytes.NewReader(payload))
req.Header.Set("Authorization", "Bearer "+os.Getenv("MAAT_PARTNER_TOKEN"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode >= 400 {
log.Fatalf("unit patch failed: %d", res.StatusCode)
}
var body unit
if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
log.Fatal(err)
}
fmt.Println(body.MaxGuests, body.Beds)
}
{
"unit_id": "8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804",
"unit_type": "apartment",
"max_guests": 4,
"bedrooms": 2,
"beds": 3,
"bathrooms": 1,
"check_in_time": "15:00",
"check_out_time": "12:00",
"amenities": [
"wifi",
"air-conditioning",
"washing-machine"
],
"house_rules": [
{
"slug": "pets_allowed",
"allowed": true
},
{
"slug": "smoking_allowed",
"allowed": false
}
],
"listings": [
{
"listing_id": "7c4b1e58-2a90-4f61-b3d2-5e8a1c0f7d24",
"inventory_kind": "unit",
"title": "Courtyard flat with the blue door",
"description": "A two-bedroom flat one street back from the corniche.",
"status": "listed",
"base_rate": {
"value": "1250.00",
"currency": "EGP"
},
"cleaning_fee": {
"value": "200.00",
"currency": "EGP"
},
"instant_booking": true,
"is_exclusive": false,
"is_best_price": true,
"rating": {
"average": 4.8,
"count": 24
},
"publishable": true,
"missing": [],
"console_url": "https://maatstays.wtf/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7"
}
]
}Change what a unit is
Changes what a unit is: how many it sleeps, in what, whether it is the whole property or a room inside one, and its door times.
Partial. An absent field is untouched — there is no merge engine and nothing
here is nullable, because every one of these columns is required on the platform.
Send at least one field: an empty body is a 400, not a silent no-op that reads
as success.
The counts are integers. A bathrooms of 2.5 is refused rather than
truncated into a different property than you described; half-bathrooms are not
expressible here.
A 403 on this operation carries one of two codes — insufficient_scope (the
key lacks catalog:write) or workspace_scope_mismatch (a sandbox/production
mismatch). Branch on code.
Setting unit_type to whole_property on a property that has another unit is
refused with 409 conflict: the whole property cannot also contain a second one.
The body is strict. An undeclared field is a 400 validation_failed naming it,
never a silent drop, and a stray query string is refused the same way.
A property with more than one unit, or more than one listing, is refused with
409 property_not_simple; a listing that is not a stay with
409 inventory_not_supported. Nothing is written either way.
Live in a sandbox workspace. Returns 501 against a production one.
curl --fail-with-body -X PATCH https://maatstays.wtf/v1/units/8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804 \
-H "Authorization: Bearer $MAAT_PARTNER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"max_guests": 5, "beds": 4, "check_in_time": "15:00"}'// Partial: an absent field is untouched. Send at least one.
const res = await fetch(
'https://maatstays.wtf/v1/units/8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804',
{
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.MAAT_PARTNER_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ max_guests: 5, beds: 4, check_in_time: '15:00' }),
},
);
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.detail}`);
console.log(body.max_guests, body.beds, body.check_in_time);
import os
import requests
# Partial: an absent field is untouched. Send at least one.
res = requests.patch(
"https://maatstays.wtf/v1/units/8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804",
headers={"Authorization": f"Bearer {os.environ['MAAT_PARTNER_TOKEN']}"},
json={"max_guests": 5, "beds": 4, "check_in_time": "15:00"},
timeout=30,
)
body = res.json()
if res.status_code >= 400:
raise RuntimeError(f"{body['code']}: {body.get('detail')}")
print(body["max_guests"], body["beds"], body["check_in_time"])
package main
import (
"bytes"
"encoding/json"
"fmt"
"log"
"net/http"
"os"
)
type unit struct {
MaxGuests int `json:"max_guests"`
Beds int `json:"beds"`
}
func main() {
// Partial: an absent field is untouched. Send at least one.
payload, _ := json.Marshal(map[string]any{
"max_guests": 5,
"beds": 4,
"check_in_time": "15:00",
})
req, _ := http.NewRequest(http.MethodPatch,
"https://maatstays.wtf/v1/units/8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804",
bytes.NewReader(payload))
req.Header.Set("Authorization", "Bearer "+os.Getenv("MAAT_PARTNER_TOKEN"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode >= 400 {
log.Fatalf("unit patch failed: %d", res.StatusCode)
}
var body unit
if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
log.Fatal(err)
}
fmt.Println(body.MaxGuests, body.Beds)
}
{
"unit_id": "8e4b2a17-5c39-4d61-b0f2-7a9c3e51d804",
"unit_type": "apartment",
"max_guests": 4,
"bedrooms": 2,
"beds": 3,
"bathrooms": 1,
"check_in_time": "15:00",
"check_out_time": "12:00",
"amenities": [
"wifi",
"air-conditioning",
"washing-machine"
],
"house_rules": [
{
"slug": "pets_allowed",
"allowed": true
},
{
"slug": "smoking_allowed",
"allowed": false
}
],
"listings": [
{
"listing_id": "7c4b1e58-2a90-4f61-b3d2-5e8a1c0f7d24",
"inventory_kind": "unit",
"title": "Courtyard flat with the blue door",
"description": "A two-bedroom flat one street back from the corniche.",
"status": "listed",
"base_rate": {
"value": "1250.00",
"currency": "EGP"
},
"cleaning_fee": {
"value": "200.00",
"currency": "EGP"
},
"instant_booking": true,
"is_exclusive": false,
"is_best_price": true,
"rating": {
"average": 4.8,
"count": 24
},
"publishable": true,
"missing": [],
"console_url": "https://maatstays.wtf/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7"
}
]
}Authorizations
A short-lived partner token, obtained by exchanging your API key at
POST /token. Send it as Authorization: Bearer <access_token>.
Tokens live for fifteen minutes by default and never for more than an hour. Mint one per batch of work, not one per request.
The token carries the workspace and the environment its key was issued for. You cannot change either by asking: the exchange ignores everything in the request body for exactly that reason.
It also carries the key's scopes (scope, a list). Every operation names a
scope as x-maat-scope, and a token whose key lacks it is refused with
403 insufficient_scope, naming the scope. Scopes are fixed when a key is
issued and are re-read from the key on every request, so a key narrowed today is
narrowed on its next call — the token's scope is what the key held at exchange
time, for your own reading, never what authorizes a request.
x-maat-scope is the floor, and on the quick-action operations it is not the
whole requirement. PUT and DELETE /listings/{listing_id}/quick-actions/{template_key}
carry rules:write, and additionally require pricing:write when
template_key begins pricing. — the capability depends on the template in
the path, because a cleaning fee changes what a guest pays and a minimum stay
does not. The refusal is the same 403 insufficient_scope, naming
pricing:write. The two READS apply the same requirement without erroring:
GET /listings/{listing_id}/quick-actions still lists the pricing.* rows but
withholds their applied state, and GET /listings/{listing_id}/rules omits the
pricing rules entirely and reports pricing_withheld in warnings. These four
are the only operations in this document whose requirement is not exactly their
x-maat-scope, and each of them says so machine-readably:
x-maat-scope-additional lists the second scope it can require and
x-maat-scope-additional-when says what happens without it.
Never send it as a cookie or in a query string, and never store it — store the API key, mint tokens from it.
Path Parameters
Maat's identifier for the physical unit.
Body
A partial edit of one physical unit. An absent member is untouched, and nothing here is nullable — every one of these is a required value on the platform.
Send at least one member. An empty body is a 400, not a silent no-op that reads
as success.
The most people the unit sleeps.
1 <= x <= 50Rooms intended for sleeping.
0 <= x <= 30Beds in total, across every room.
0 <= x <= 60Whole bathrooms. A fractional value is refused rather than truncated into a different property than you described; half-bathrooms are not expressible here.
0 <= x <= 30Local time, 24-hour.
^([01]\d|2[0-3]):[0-5]\d$"15:00"
Local check-out time, 24-hour HH:MM. The platform default is 12:00.
^([01]\d|2[0-3]):[0-5]\d$"12:00"
Response
The unit, read back after the change.
One physical unit, and the listings sold on it.
What kind of physical inventory this is, as a slug.
The most people the unit sleeps.
Rooms intended for sleeping.
Beds in total, across every room.
Whole bathrooms. Half-bathrooms are not expressible.
Local HH:MM, 24-hour.
^([01]\d|2[0-3]):[0-5]\d$"15:00"
Local check-out time, 24-hour HH:MM. The platform default is 12:00.
^([01]\d|2[0-3]):[0-5]\d$"12:00"
Amenity slugs. See GET /catalog/amenities.
Every house rule that has been answered for this unit. A rule that was never asked is absent.
Show child attributes
Show child attributes
The sellable views of this unit. One today; the model allows more.
Show child attributes
Show child attributes
The unit's id — the one GET /units/{unit_id} takes.