Create an appointment (public)

post

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

Create a new appointment (public route).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ResourceIds

array of uuids

required

ResourceIds*

LocationId

uuid

required

ServiceId

uuid

required

allowPaddingOverflow

boolean

Defaults to false

When true, allows padding past operating-hours close only on the last availability block of the local day. Mid-day slots still enforce full padding.

ignoreExternalEvents

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

status

string

enum

Defaults to IN

Allowed:

bookedBy

string

confirmed

boolean

Defaults to false

notes

string

location

string

latitude

number

longitude

number

repeated

boolean

Defaults to false

duration

integer

required

≥ 1

Duration of the appointment in minutes

ipAddress

string

CustomFields

object

Customer

object

Unavailability

object

required

Responses

400

Invalid body or missing required fields.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Creates a appointment