Create a booking

Use this endpoint to create a booking.

Please refer to our tutorial on creating a booking for a more detailed description: http://help.timekit.io/working-with-the-api/bookings/creating-a-booking

If you need an introduction the the booking concept as Timekit sees it, please refer to our introduction: http://help.timekit.io/working-with-the-api/bookings/introduction-to-bookings

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Settings

Use the settings for additional settings. Currently we support these additional settings:

  • allow_double_bookings which defaults to false. If you want bookings to allow overlapping you can set this to true
{
  "resource_id": "d187d6e0-d6cb-409a-ae60-45a8fd0ec879",
  "graph": "confirm_decline",
  "start": "2018-08-12T21:30:00-07:00",
  "end": "2018-08-12T22:15:00-07:00",
  "what": "Catch the lightning",
  "where": "Courthouse, Hill Valley, CA 95420, USA",
  "description": "The lightning strikes at 10:04 PM exactly! I need you to be there Doc!",
  "customer": {
    "name": "Marty McFly",
    "email": "[email protected]",
    "phone": "(916) 555-4385",
    "voip": "McFly",
    "timezone": "America/Los_Angeles"
  },
  "settings": {
    "allow_double_bookings": true
  }
}

🚧

Understanding the "invite" flag

If the booked resource is synced with an external service, like Google or Microsoft, the service can automatically send its own built in "invitation" notifications to the participants, once an event is put into a calendar. This is controlled by the invite flag, which is false by default.

If you want invitations to be sent, make sure to include the customer's (recipient) email in the participants array, like so:

"participants": [
  "[email protected]"
]

If you also add the resource's (event owner) email to the participants list in addition to the customer email, you can choose the initial RSVP status for event with the my_rsvp parameter.

🚧

Book already reserved slot

Final step in the reservation process where customers can request an actual appointment via this endpoint. You can pass reservation_id to above endpoint to create a booking for existing reservation.

Query Params
string

Include booking attributes such as event_info in the response

Body Params
string

If you want to use the settings specified in the project. Any additional parameters in the request will override those set in the project

string
required

The ID of the resource being booked

string
required

Name of the flow graph you want to use. Please refer to our graph reference https://developers.timekit.io/reference/graphs

customer
object
required

Customer info (dependending on the chosen graph!) the customer is the person booking the resource.

date-time
required

When the booking starts

date-time
required

When the booking ends

string
required

The title of the booking

string
required

A description of the location of the booking

string
required

a description of the booking

boolean
Defaults to false

Send provider invitation emails when using google/microsoft. False by default. See details in note below.

participants
array of strings
Defaults to []

A list of emails to invite as participants (when using google/microsoft). See details in note below.

participants
string
Defaults to accepted

Set your own RSVP when using google/microsoft. See details in note below.

string

If you need to save the booking in a different calendar than the resource's primary, you need to supply this

string

If you have reserved a time slot earlier using reservation endpoint add your reservation id here to create booking from your reserved slot

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json