Skip to Content
ReferenceAPIBookingUpdate a resource

Booking API

Update a booking resource

Update a schedulable resource in the current workspace.

PATCH/v1/booking/resources/{resourceId}
capability booking.resources.update · v1operational dataserver-scoped workspace

Request

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

  • resourceIdstring<uuid>required
    path
  • namestring
    bodymin length 1max length 120
  • status"active" | "inactive"
    body
  • expectedUpdatedAtstring<date-time>required
    body

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.
  • 404The booking resource could not be found.
  • 409The booking resource changed.
  • 422The booking resource update is invalid.
  • 503The booking resource could not be updated.
Last updated on