Skip to content
Quarters Developers
esc
  • Type an endpoint, an object or a word from a guide.

Inquiries

Create an inquiry

POST /api/v1/inquiries

Anything your form collects beyond the fields below travels in metadata untyped, so the form can evolve without a contract change.

Request body

application/json, shaped as InquiryInput.

FieldTypeDescription
propertyId stringMust be one of your published listings, so a typo fails loudly rather than creating an orphan.
firstName string max 100 chars
lastName requiredstring max 100 chars
email requiredemail max 200 chars
phone string max 50 chars
checkIn date YYYY-MM-DD
checkOut dateMust be after checkIn. YYYY-MM-DD
adults integerThe tenants picker, one field per age band. 0–20
children integer 0–20
infants integer 0–20
pets boolean
guestCount integerDeprecated: folded into adults. Send the age bands instead. 1–50
message string max 10000 chars
locale stringWhich language they were reading. max 10 chars
source stringWhere the form lives. Defaults to website. max 50 chars
metadata objectAnything else your form collects. At most 10 KB serialised. Travels untyped, so the form can evolve without a contract change.

Response

201 { id: string }

Errors

Every failure is { error, message }; see Errors. A missing or expired bearer is a 401 on every endpoint but the token exchange.

StatuserrorWhen
400invalid_requestA bad field, with a message naming its path. An unknown or unpublished propertyId is a 400 too.
429rate_limitedMore than the organisation’s daily allowance (500 by default) in 24 hours.

Notes

  • guestCount is still accepted and folded into adults. It is deprecated; send the age bands.
  • An inquiry never blocks a day. It becomes a booking when staff convert it.

Request

curl -X POST "https://go.quarters.live/api/v1/inquiries" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "propertyId": "0d6e1c2a-…",
    "firstName": "Sofia",
    "lastName": "Rossi",
    "email": "sofia@example.com",
    "phone": "+39 333 000 0000",
    "checkIn": "2026-10-01",
    "checkOut": "2027-04-01",
    "adults": 2,
    "children": 0,
    "infants": 0,
    "pets": false,
    "message": "Two of us, relocating for a project.",
    "locale": "en",
    "source": "website",
    "metadata": {
      "page": "https://www.cityretreat.com/house/…"
    }
  }'

Response · 201

{
  "id": "2c9d…"
}