To create office
This api is used to create offices. Create office by sending a POST request to the endpoint below.
POST /add-office
Request Body:
{
"site_id": "ST000000",
"office_type": "serviced",
"size": "100",
"amount": "500",
"max_people_count": "5",
"deposit_terms": "2",
"rent_terms": "12",
"commission_rate": "10",
"available_for_booking": "upcoming",
"available_from_date": "2025-10-01",
}
Response:
{
"success": true,
"data": {
"office": {
"office_id": "OPL0000000000",
"site_id": "ST000000",
"office_type": "serviced",
"size": 100,
"amount": 500,
"max_people_count": 5,
"deposit_terms": 2,
"rent_terms": 12,
"commission_rate": 10,
"available_for_booking": "upcoming",
"available_from_date": "2025-10-01",
"status": "active",
"created_at": "2025-09-14T11:05:10.000000Z",
"updated_at": "2025-09-14T11:05:10.000000Z",
}
},
"message": "Office created"
}
Description:
| Field Name | Description |
|---|---|
| access_token* | Access token, obtain it from authentication api |
| site_id* | Unique Site Id under which office will be created (string) |
| type* | Type of office - serviced or managed |
| size* | Size of office (number) |
| amount* | Price of office (number) |
| max_people_count* | Capacity of office (number) |
| deposit_terms* | Deposit terms (number) |
| rent_terms* | Rent terms (number) |
| commission_rate* | Commission rate (number) |
| available_for_booking* | Availability of office - available, occupied or upcoming |
| available_from_date* | Availability date of office required in case of occupied or upcoming (date) |