API reference
Unit types
Kinds of home in a project.
PATCH/unit-types/{id}
Change a unit type
Needs the permission projects:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
name | string | at least 1 characters. up to 120 characters |
propertyType | one of apartment, villa, townhouse, penthouse, office, retail, plot, other | |
bedrooms | integer or null | |
bathrooms | integer or null | |
areaSqft | number or null | |
carpetAreaSqft | number or null | |
basePrice | number | at least 0. up to 10000000000000 |
totalUnits | integer | at least 0. up to 100000 |
description | string or null |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/unit-types/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text","propertyType":"apartment","bedrooms":0}'Responses:
200 400 401 402 403 404 412 429
DELETE/unit-types/{id}
Delete a unit type
Needs the permission projects:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X DELETE https://crm.anibrosdesign.com/api/v1/unit-types/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
204 400 401 402 403 404 429
GET/unit-types/{id}/interested
Get interested (unit types)
Needs the permission projects:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/unit-types/{id}/interested \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
POST/unit-types/{id}/units
Units (unit types)
Needs the permission properties:create.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) | |
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 |
|---|---|---|
count | integer | at least 1. up to 500 |
unitPrefix | string | up to 20 characters |
startAt | integer | at least 1. up to 100000 |
tower | string or null | |
facings | list of string | up to 50 items |
floorFrom | integer | at least -5. up to 200 |
floorTo | integer | at least -5. up to 200 |
perFloor | integer | at least 1. up to 50 |
curl -X POST https://crm.anibrosdesign.com/api/v1/unit-types/{id}/units \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"count":1,"unitPrefix":"text","startAt":1}'Responses:
201 400 401 402 403 404 429
Something missing or unclear? Tell us.