Skip to main content
POST
cURL
Guide: Booking events. Errors: Errors and limits.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
event
string
required

Event name. Letters, digits, spaces and . _ : -.

Example:

"booking.created"

tenant
string

The restaurant. Its rules apply on top of the defaults, and the guest belongs to it.

Example:

"restaurant_4812"

email
string

The guest. Or contactId or phone.

Example:

"anna@example.com"

contactId
integer
Example:

4521

phone
string
Example:

"+393331234567"

firstName
string
Example:

"Anna"

lastName
string
Example:

"Rossi"

payload
object

Any JSON. Each value is a merge variable of the email, by its path in capitals (booking.time becomes BOOKING_TIME). Dates with their UTC offset, else 422 INVALID_EVENT_DATE.

Example:
idempotencyKey
string

Your unique id of this event. Sent again, nothing happens twice and status is duplicate.

Example:

"booking-9921-created"

cancellationKey
string

Groups the emails of one object, for example the booking id. A later booking.cancelled with the same key cancels them; booking.updated moves them.

Example:

"booking-9921"

true records the guest's marketing consent to this restaurant, also for a guest who exists, with the event as evidence. Add details in payload.consentEvidence. An event never withdraws a consent.

from
string

Sender of the emails of this event: "Name <address>" or an address under a verified domain of your workspace. Checked now and again at send time.

Example:

"Trattoria da Mario <bookings@yoursaas.example>"

replyTo
string

Reply-To of the emails of this event. Any mailbox.

Example:

"owner@trattoriadamario.example"

Response

What was scheduled

data
object