Booking Pages

Create a booking page

post/booking-pages

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/booking-pages
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

namestring required
mailboxstring email required

The mailbox whose availability the page exposes.

slugstring required

URL slug, lowercase letters, numbers, and hyphens.

duration_minutesinteger required
availability_daysinteger[] required

Weekdays offered, 0=Sunday .. 6=Saturday.

window_start_minutesinteger required
window_end_minutesinteger required
timezonestring required
descriptionstring nullable
buffer_minutesinteger
minimum_notice_minutesinteger
max_advance_daysinteger
conferencing_provider'zoom' | 'google_meet' nullable

Opt-in provider used to create a meeting for each booking. Null or omission means no meeting link. The provider must already be connected to the page's mailbox, or the request is rejected.

activeboolean

Response

Booking page created.

object'booking_page' required
idstring required
mailboxstring email required

The mailbox whose availability the page exposes.

slugstring required
urlstring nullable required

Public booking URL.

namestring required
descriptionstring nullable required
duration_minutesinteger required
availability_daysinteger[] required

Weekdays offered, 0=Sunday .. 6=Saturday.

window_start_minutesinteger required

Start of the daily window, minutes from midnight.

window_end_minutesinteger required

End of the daily window, minutes from midnight.

timezonestring required
buffer_minutesinteger required
minimum_notice_minutesinteger required
max_advance_daysinteger required
conferencing_provider'zoom' | 'google_meet' nullable required

Opt-in provider used to create a meeting for each booking. Null means no meeting link. The provider must already be connected to the page's mailbox, or the request is rejected.

activeboolean required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.