Skip to Content
ReferenceAPIBookingCreate a resource

Booking API

Create a booking resource

Create a schedulable person, site, room, or equipment resource in the current workspace.

POST/v1/booking/resources
capability booking.resources.create · v1operational dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

  • namestringrequired
    bodymin length 1max length 120
  • kind"person" | "site" | "room" | "equipment"required
    body
  • practitionerIdstring<uuid> | null
    bodydefault null
  • parentResourceIdstring<uuid> | null
    bodydefault null
  • scheduleIdstring<uuid> | null
    bodydefault null

Response

Successful responses use Dawn's data envelope.

  • dataBookingResourcerequired
    • idstring<uuid>required
    • workspaceIdstring<uuid>required
    • namestringrequired
      min length 1max length 120
    • kind"person" | "site" | "room" | "equipment"required
    • status"active" | "inactive"required
    • practitionerIdstring<uuid> | nullrequired
    • parentResourceIdstring<uuid> | nullrequired
    • scheduleIdstring<uuid> | nullrequired
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
  • metaobject

Errors

Error responses use the shared error envelope.

  • 403Scheduling is disabled or a workspace member is required.
  • 422The booking resource is invalid.
  • 503The booking resource could not be saved.
Last updated on