Create Booking
POST/v1/bookingsThe Create Booking API allows users to make a new booking. By submitting necessary details such as service selection, contact information, and preferred time slots, this API will create a new booking in the system. Upon successful creation, the API returns the booking details and a unique identifier for future reference.
Request
Body Params application/json
startedAt
string <date-time>
required
timeZone
string
required
eventTypeId
string
required
email
string <email>
required
<= 255 characters
name
string
required
<= 64 characters
company
string
optional
<= 32 characters
textRemindCountryCode
string
optional
<= 255 characters
textRemindNumber
string
optional
<= 32 characters
ccEmails
array[string]
optional
<= 30 items
message
string
optional
<= 2000 characters
locale
enum<string>
optional
Allowed values:
jaen
locationId
required
Any of
Allowed values:
inPersonphonezoomgoogleMeetaskInviteeteamscustom
phoneNumber
string
optional
<= 32 characters
tracking
object
optional
campaign
string
optional
<= 255 characters
source
string
optional
<= 255 characters
medium
string
optional
<= 255 characters
content
string
optional
<= 255 characters
term
string
optional
<= 255 characters
answers
array [object {2}]
optional
questionUid
string
required
content
required
payment
object
optional
paymentMethod
enum<string>
required
Allowed values:
nonecardonsite
items
array [object {1}]
required
successUrl
string <uri>
optional
cancelUrl
string <uri>
optional
Example
{
"eventTypeId": "mzgdPJVBb7RE",
"timeZone": "Asia/Tokyo",
"startedAt": "2024-03-16T02:00:00.000Z",
"email": "guest@example.com",
"name": "john doe",
"location": null
}Request samples
Responses
Created(201)
Conflict(409)
HTTP Code: 201
Content Type : JSONapplication/json
Data Schema
data
required
Any of
Example
Success
{
"eventTypeId": null,
"uid": "dolor id nostrud Excepteur dolore",
"name": "nostrum neque nostrum",
"description": "Facere non eveniet illo veritatis doloribus id quos omnis nemo. Facilis quis assumenda sunt. Unde iusto porro placeat. Itaque amet aut voluptas facilis rerum illo error.",
"status": "open",
"startedAt": "1989-06-01T18:37:12.594Z",
"endedAt": "1984-11-20T03:14:06.112Z",
"locationId": "phone",
"url": "https://acrobatic-son.org",
"phoneNumber": "(648) 998-7709 x67849",
"address": null,
"customLocation": "eiusmod",
"access": null,
"timeZone": "Atlantic/Azores",
"priority": "high",
"cancelReason": "veniam fugiat quis elit",
"cancelledAt": null,
"cancelledBy": null,
"capacity": null,
"hosts": [
{
"userId": "non",
"role": "editor"
}
],
"createdAt": "2024-03-04T07:26:55.198Z",
"updatedAt": "2024-03-04T05:10:21.686Z"
}Last modified: 3 days ago