Create Service Booking

POST 
/calendars/services/bookings

Create a new service booking

Request

Version stringrequired

API Version

Available optionsv3

overrideAvailability boolean

If true the time slot validation would be avoided for any booking creation/update (even the skipSchedulingNotice)

Default value:false

skipSchedulingNotice boolean

If set to true, the minimum scheduling notice and date range would be ignored

Default value:false

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

contactIdstringrequired

Contact ID

startTimestringrequired

Start Time

endTimestringrequired

End Time

timezonestringrequired

Timezone

servicesobject[]required

Services

serviceLocationIdstring

Service Location ID (If not provided, then the default service location will be used)

meetingLocationstring

Meeting Location (If service location is an ask the booker, then the meeting location is required)

titlestring

Service Booking Title

statusstring
Status. (If not provided, the status configured in Service Global Settings will be used.)
Available optionsconfirmednew

Example (auto)

{
  "locationId": "0007BWpSzSwfiuSl0tR2",
  "contactId": "9NkT25Vor1v4aQatFsv2",
  "startTime": "2021-06-23T03:30:00+05:30",
  "endTime": "2023-09-25T16:30:00+05:30",
  "timezone": "America/New_York",
  "services": [
    {
      "id": "a3b4c5d6e7f8901234567890",
      "staffId": "8MkU36Wps2w5bRbuGtw3"
    }
  ],
  "serviceLocationId": "65e5f6dfacf123513228d384",
  "meetingLocation": "123 Main St, Anytown, USA",
  "title": "Service Appointment",
  "status": "confirmed"
}

application/json

Booking created successfully

application/json

Schema

Schema

bookingIdstringrequired

Booking ID

locationIdstringrequired

Location ID

contactIdstringrequired

Contact ID

serviceLocationIdstringrequired

Service Location ID

titlestringrequired

Service Booking Title

startTimestringrequired

Start Time

endTimestringrequired

End Time

servicesobject[]required

Services

timezonestringrequired

Timezone

statusstringrequired

Status

deletedbooleanrequired

Tells if the booking is deleted

dateAddedstringrequired

Date Added

dateUpdatedstringrequired

Date Updated

createdByobjectrequired

Booking booked by metadata

meetingLocationstring

Meeting Location (If service location is an ask the booker, then the meeting location is used for the booking)

messagesarray[]

Optional informative or warning messages (e.g. meeting location ignored for non-ask-booker locations)

Example (auto)

{
  "bookingId": "7NkT25Vor1v4aQatFsv2",
  "locationId": "0007BWpSzSwfiuSl0tR2",
  "contactId": "9NkT25Vor1v4aQatFsv2",
  "serviceLocationId": "65e5f6dfacf123513228d384",
  "title": "John Doe - Hair Styling",
  "startTime": "2023-09-25T16:00:00+05:30",
  "endTime": "2023-09-25T16:30:00+05:30",
  "services": [
    {
      "id": "68e5f6dfacf123513228d384",
      "serviceCategoryId": "3c4d5e6f7890123456789abc",
      "serviceStaffId": "7NkT25Vor1v4aQatFsv2",
      "serviceStartTime": "2023-09-25T16:00:00+05:30",
      "serviceEndTime": "2023-09-25T16:30:00+05:30"
    }
  ],
  "timezone": "America/New_York",
  "status": "confirmed",
  "deleted": false,
  "dateAdded": "2023-09-25T16:00:00+05:30",
  "dateUpdated": "2023-09-25T16:00:00+05:30",
  "createdBy": {
    "userId": "7NkT25Vor1v4aQatFsv2",
    "source": "public_api"
  },
  "meetingLocation": "123 Main St, Anytown, USA",
  "messages": [
    "Meeting location is not supported for the selected service location and has been ignored."
  ]
}