Skip to content
campaiDeveloper
campai.com

Booking · Resources · Reservations

POST/{organizationId}/{mandateId}/booking/resources/reservations/delete

Delete reservations

Deletes the selected custom reservations in one transaction, at most 200 at once. Bookings and event reservations are skipped. An empty selection covers every reservation matching the filter.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • resource.read
  • resourceReservation.remove

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • searchTermstring
  • resourceIdsid[]
  • bookingIdid
  • siteIdid
  • typestring
    booking event custom
  • typesstring[]
    booking event custom
  • statusstring[]
    pending confirmed canceled checkedIn reserved maintenance blocked outOfOrder closed other
  • periodobject
    2 properties
    • fromstring · date-timerequired
    • tostring · date-timerequired
  • userFilterstringnullable

    A stringified json object representing a property filter

  • selectionobjectrequired
    2 properties
    • excludeIdsid[]

      1–1000 items

    • idsid[]

      1–1000 items

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/resources/reservations/delete' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • deletedinteger

    at least 0

Response200
{
  "deleted": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.