Skip to main content
POST
Call a web-found business to book

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 called.

Maximum string length: 2048
Example:

"https://barbers.example/book"

service
string
required

What to book, in plain words, such as upright piano full tuning and pitch raise. Put when the user can come in timing, the staff member they asked for in staff and their booking details in notes. Never put contact details (phone, email, address) in it.

Required string length: 1 - 120
Example:

"upright piano full tuning and pitch raise"

timing
string

When the user can come, in their words, such as Thursday after 5 or Friday morning. Leave it out when they named no window. Never put contact details in it.

Required string length: 1 - 120
Example:

"Thursday after 5 or Friday morning"

staff
string

The staff member the user asked for, in their words, such as Sam. Leave it out when they named none; never take one from the business's page.

Required string length: 1 - 80
Example:

"Sam"

notes
string

Booking details the user gave for this booking, such as allergic to lavender. Only what they said, never contact details. Leave it out when they gave none.

Required string length: 1 - 200
Example:

"allergic to lavender"

daysFromToday
number

The day the user asked for, in days from today in their saved time zone: 0 today, 1 tomorrow. Cal asks the business for that date. Leave it out when the user named no day.

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

1

callerName
string

The name the user gave for themselves, which Cal gives on the call. Leave it out to use the account name; never a name from a search result.

Required string length: 1 - 80
Example:

"Jamie Rivera"

Response

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

"success"

data
object
required