Reservations
Offers, reservations and sales on units.
GET/reservations
List reservations
Needs the permission reservations:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
limit | query | integer | at least 1. up to 200. default 50 |
cursor | query | string | up to 512 characters |
leadId | query | string (uuid) | |
propertyId | query | string (uuid) | |
status | query | string | up to 80 characters |
completedFrom | query | string | |
completedTo | query | string | |
test | query | one of exclude |
curl -X GET https://crm.anibrosdesign.com/api/v1/reservations \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
POST/reservations
Create a reservation
Needs the permission reservations:create.
| Parameter | In | Type | Notes |
|---|---|---|---|
Idempotency-Key | header | string | Any unique string up to 128 characters. Repeating the request with the same key returns the first response. up to 128 characters |
| Body field | Type | Notes |
|---|---|---|
leadId required | string (uuid) | |
propertyId required | string (uuid) | |
offerPrice | number or null | |
holdUntil | string (date-time) or null | |
note | string or null |
curl -X POST https://crm.anibrosdesign.com/api/v1/reservations \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"leadId":"01a15d23-0000-7000-8000-000000000000","propertyId":"01a15d23-0000-7000-8000-000000000000","offerPrice":0}'Responses:
201 400 401 402 403 429
GET/reservations/by-property/{propertyId}
Get by property (reservation)
Needs the permission properties:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
propertyId required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/reservations/by-property/{propertyId} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
GET/reservations/close-reasons
Get close reasons (reservations)
Needs the permission reservations:read.
curl -X GET https://crm.anibrosdesign.com/api/v1/reservations/close-reasons \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 401 403 429
GET/reservations/{id}
Get a reservation
Needs the permission reservations:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/reservations/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
PATCH/reservations/{id}
Change a reservation
Needs the permission reservations:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
offerPrice | number or null | |
agreedPrice | number or null | |
holdUntil | string (date-time) or null | |
note | string or null |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/reservations/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"offerPrice":0,"agreedPrice":0,"holdUntil":"2026-10-24T10:00:00Z"}'Responses:
200 400 401 402 403 404 412 429
POST/reservations/{id}/close
Close (reservations)
Needs the permission reservations:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
reason required | one of buyer_withdrew, offer_rejected, price_not_agreed, financing_failed, chose_other_unit, hold_expired, other | |
note | string or null |
curl -X POST https://crm.anibrosdesign.com/api/v1/reservations/{id}/close \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"reason":"buyer_withdrew","note":"text"}'Responses:
200 400 401 402 403 404 429
POST/reservations/{id}/complete
Complete (reservations)
Needs the permission reservations:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
dealValue required | number | at least 0.01. up to 10000000000000 |
curl -X POST https://crm.anibrosdesign.com/api/v1/reservations/{id}/complete \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"dealValue":0.01000000000000000020816681711721685132943093776702880859375}'Responses:
200 400 401 402 403 404 429
POST/reservations/{id}/reserve
Reserve (reservations)
Needs the permission reservations:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
tokenAmount required | number | at least 0. up to 10000000000000 |
agreedPrice required | number | at least 0.01. up to 10000000000000 |
holdUntil | string (date-time) or null | |
note | string or null |
curl -X POST https://crm.anibrosdesign.com/api/v1/reservations/{id}/reserve \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"tokenAmount":0,"agreedPrice":0.01000000000000000020816681711721685132943093776702880859375,"holdUntil":"2026-10-24T10:00:00Z"}'Responses:
200 400 401 402 403 404 429
Something missing or unclear? Tell us.