Book an event

POST {{baseUrl}}/v3/scheduling/bookings?configuration_id={{configuration_id}}

Books an event with the participants listed in the session's Configuration object, using the details from the Configuration object. The start_time and end_time must correspond to a valid time slot returned by the Scheduling Availability endpoint using the same configuration.

Nylas validates the session ID and uses it to retrieve the related Configuration object. If you created a public configuration, you don't need to include the Authorization request header with a session ID, but you must pass the Configuration object ID as a query parameter.

Request Params

KeyDatatypeRequiredDescription
timezonestringThe timezone to use for the booking. If not provided, Nylas uses the timezone from the Configuration object.
configuration_idstringThe ID of the Configuration object whose settings are used for the booking. If you're not using session authentication (requires_session_auth is set to false), this field is required.

Request Body

{"start_time"=>"<string>", "end_time"=>"<string>", "guest"=>{"email"=>"<string>", "name"=>"<string>"}, "participants"=>[{"email"=>"<string>"}, {"email"=>"<string>"}], "timezone"=>"<string>", "additional_guests"=>[{"email"=>"<string>", "name"=>"<string>"}, {"email"=>"<string>", "name"=>"<string>"}], "additional_fields"=>{"pariaturf7"=>"<string>", "cillum1bc"=>"<string>", "sit01"=>"<string>", "amet__39"=>"<string>"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;request_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;data&quot;:&quot;\u003cobject\u003e&quot;}