Skip to main content
POST
Book a web-found business online

Headers

Authorization
string
required

value must be Bearer <token> where <token> is api key prefixed with cal_, managed user access token, or OAuth access token

Body

application/json
businessUrl
string
required

The business's URL, exactly as a search_listings web business gave it in webBusinesses[].url. Only a business found by your own search in the last 24 hours can be booked.

Maximum string length: 2048
Example:

"https://barbers.example/book"

service
string
required

What to book, in plain words, such as haircut.

Required string length: 1 - 80
Example:

"haircut"

area
string
required

The user's area as they gave it: a ZIP code, neighborhood or city.

Required string length: 1 - 120
Example:

"Capitol Hill, Seattle"

daysFromToday
number
required

The day the user asked for, in days from today in their saved time zone: 0 today, 1 tomorrow.

Required range: 0 <= x <= 60
Example:

1

partOfDay
enum<string>
required

The part of that day the user asked for; any when they did not say.

Available options:
morning,
afternoon,
evening,
any
Example:

"afternoon"

idempotencyKey
string
required

A key you generate once per booking, such as a UUID. Send the same key to retry the same request: you get its job back, and no second job starts.

Required string length: 1 - 100
Example:

"4b7d1c2e-9f0a-4e1b-8c3d-2a6f5e7d9b10"

budgetDollars
number

The most the user wants to pay for the service, in US dollars, when they said so.

Required range: 1 <= x <= 100000
Example:

60

Response

status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
object
required