...
| Parameter | Description |
|---|---|
hotel_id | Property Numerical identifier Cannot be null |
Guest | see list of supported strings |
| Category string required | form category name from the categories endpoint |
| room string optional | Guest room for their booking |
| booking_id string optional | The reservation identifier for the guests stay with the property, if applicable. |
| guest_notify boolean required | Should an email be sent to the guest notifying them of this requests creation? Recommended false |
| staff_username string optional |
|
| form_name string required | Name of the form we are creating this request for from the forms endpoint |
| form_fields array required | details of the form request. Needs to match any required form_fields for the specified form_name from the forms forms endpoint |
Requests Guest Array
...
...
name
string
required
...
email
string
required
...
Example Request
| Code Block |
|---|
{
"hotel_id": 2,
"room": "32",
"booking_id": "1332025-4X",
"guest": {
"email": "joeb@banks.com",
"name": "Joe Banks",
"phone": "7075551414"
},
"guest_notify": false,
"form_category": "Treatment",
"form_name": "Spa Menu",
"form_fields": {
"Notes": "We'd like hot towels and a room to meditate in",
"swedish1": 2,
"pregnancy2": 1
}
} |
...
| Code Block |
|---|
{
"requests": {
"id": 878,
"booking_id": "1332025-4X",
"room": "32",
"guest": {
"name": "Joe Banks",
"email": "joeb@banks.com",
"phone_number": "7075551414"
},
"created_at": "2020-02-12 15:43:15",
"updated_at": "2020-02-12 15:43:15",
"length_open": "1 second",
"status": "New",
"assigned": null,
"category": {
"id": 8,
"name": "Treatment"
},
"request_details": [
{
"name": "Notes",
"value": "We'd like hot towels and a room to meditate in",
"amount": null,
"type": "text"
},
{
"name": "Swedish1",
"value": "2",
"amount": "80",
"type": "amount"
},
{
"name": "Pregnancy2",
"value": "1",
"amount": "140",
"type": "amount"
}
],
"comments": {
"guest_comments": [],
"staff_notes": []
}
},
"api_version": 3,
"status": "success",
"request_uuid": "a25a7d79-ba8a-40a3-92a6-02862f7a16c2"
}
|
Update a Request
This call creates a new request and returns a request object.
| Code Block |
|---|
PUT v3/requests/:request_id |
Request URL Parameters
| Parameter | Description |
|---|---|
| id integer required | The ID of the request resource being managed |
hotel_id | Property Numerical identifier Cannot be null |
Guest | see list of supported strings |
| Category string required | form category name from the categories endpoint |
| room string optional | Guest room for their booking |
| booking_id string optional | The reservation identifier for the guests stay with the property, if applicable. |
| guest_notify boolean required | Should an email be sent to the guest notifying them of this requests update? Recommended false |
| staff_username string optional |
|
| status integer optional |
|
| form_name string required | Name of the form we are creating this request for from the forms endpoint |
| form_fields array required | details of the form request. Needs to match any required form_fields for the specified form_name from the forms forms endpoint |
Requests Guest Array
| Anchor | ||||
|---|---|---|---|---|
|
| Parameter | Description |
|---|---|
name | Guest fullname i.e. "John Doe" |
email | guest email |
| phone string required | guests preferred phone number |