To create site
This api is used to create site. Create site by sending a POST request to the endpoint below.
POST /add-site
Request Body:
{
"name": "dummy",
"description": "site description",
"meta_description": "meta",
"type": "head office",
"address": "dummy",
"city": "dummy",
"state": "dummy",
"postcode": "12345",
"country": "United Kingdom",
"latitude": "51.5809694",
"longitude": "-0.3344616",
"timezone": "Europe/London",
"images": [
{
"title": "Front View",
"path": "https://example.com/images/front.jpg"
},
{
"title": "Reception Area",
"path": "https://example.com/images/reception.jpg"
}
],
"facilities": [
"wifi",
"parking"
],
"availabilities": [
{
"day": "monday",
"time_in": "09:00",
"time_out": "18:00",
},
{
"day": "tuesday",
"time_in": "09:00",
"time_out": "18:00",
},
.....
],
"holidays": [
{
"name": "Christmas",
"date": "2025-12-25",
"time_in": "00:00",
"time_out": "23:59"
},
{
"name": "New Year",
"date": "2025-01-01",
"time_in": "00:00",
"time_out": "23:59"
}
],
"nearby_places": [
{
"type": 1,
"name": "dummy",
"distance": 10
},
{
"type": 2,
"name": "dummy",
"distance": 15
}
]
}
Response:
{
"success": true,
"data": {
"site": {
"rec_no": "ST000000",
"name": "dummy",
"slug": "dummy",
"description": "site description",
"meta_description": "meta",
"type": "head office",
"address": "dummy",
"city": "dummy",
"state": "dummy",
"postcode": "12345",
"country": "United Kingdom",
"latitude": "51.5809694",
"longitude": "-0.3344616",
"timezone": "Europe/London",
"status": "active",
"availability": "day",
"time_in": "09:00:00",
"time_out": "18:00:00",
"created_at": "2025-09-04T17:43:47.000000Z",
"updated_at": "2025-09-04T04:48:36.000000Z",
}
},
"message": "Site created"
}
Description:
| Field Name | Description |
|---|---|
| access_token* | Access token, obtain it from authentication api |
| name* | Name of the site (string) |
| description* | Description of the site (string) |
| meta_description | Meta description for SEO (max 160 characters) |
| type* | Type of the site - head office, branch, affiliate, regional |
| address* | Address of site (string) |
| city* | City of site (string) |
| state* | State of site (string) |
| postcode* | Postcode of site (integer) |
| country* | Country name of site (string) |
| latitude* | Latitude of site (integer) |
| longitude* | Longitude of site (integer) |
| timezone* | Timezone of site |
| images* | At least one image required. Each with a title and URL. |
| facilities* | At least one facility required (slug). |
| availabilities* | Atleast one availability required - 24/7, week, day along with time_in and time_out |
| holidays* | Add holidays along with name, date, time_in and time_out |
| nearby_places | Add nearby places, types - 1 = Train Station, 2 = Tube / Subway, 3 = Tram, 4 = Bus Station, 5 = Parking Lot, 6 = Airport, 7 = Ferry Port, along with distance and name |