HomeBook an Intro CallStartup Program
API Endpoints

Create an appointment

post
https://api-stage.onsched.com/v3/appointment

Create a new appointment. By default, posting with status BK books immediately and requires full details.

  • Use the hold route POST /v3/appointment/hold to create a minimal hold first
  • Required time fields: startTime, endTime (ISO 8601, e.g., 2016-10-30T09:00:00-05:00)
  • Choose the approach that fits your workflow
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ResourceIds
array of uuids
required

Create query param per resource, ex. (ResourceIds=uuid1&ResourceIds=uuid2)

ResourceIds*
uuid
required
uuid
required
boolean
Defaults to false

When true, creates a separate padding event in external calendars (Google Calendar, Outlook)

boolean
Defaults to false

When true, allows the padding to overflow the end of the slot.

boolean
Defaults to true

When false, the customer is not added as an attendee on the external calendar event.

boolean
Defaults to false

When true, skips validation against external calendar events (reasonType EXT), allowing appointment creation even if an external calendar block exists.

Body Params
string
enum
Defaults to IN
Allowed:
string
boolean
Defaults to false
string
string
number
number
boolean
Defaults to false
integer
required
≥ 1

Duration of the appointment in minutes

string
CustomFields
object
Customer
object
Unavailability
object
required
Responses

400

Invalid body or missing required fields.

401

Unauthorized.

403

Forbidden.

409

Conflict (time slot no longer available).

Updated 5 months ago

Language
Credentials
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago