Cancel a slot and its live bookings

POST/v2/experiences/{experienceId}/options/{optionId}/slots/{slotId}/cancel

Requires your API key in the X-API-Key header.

Cancels an availability slot and every live booking on it in one atomic operation. Requires authentication and is restricted to the experience's organizer; externally-sourced experiences/options are rejected with 400.

The slot is closed for sales and soft-deleted. Each live booking (ACCEPTED/PENDING/ON_HOLD) is cancelled with cancelledBy: Organizer, a full refund (zero cancellation fee) and the optional reason recorded on it; the usual per-booking notifications and refunds fire, except ON_HOLD cart bookings, which are silently transitioned to EXPIRED with no side effects.

Requestbash
curl -X POST "https://api.turneo.co/v2/experiences/8e7d6c5b-4a39-4281-90ef-1a2b3c4d5e6f/options/3d3f9c2a-1b2c-4d5e-8f90-a1b2c3d4e5f6/slots/6a5b4c3d-2e1f-4a9b-8c7d-6e5f4a3b2c1d/cancel" \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Bad weather"
  }'

Path parameters

  • experienceIdstring (uuid)required

    UUID of the parent experience.

    Example:
    8e7d6c5b-4a39-4281-90ef-1a2b3c4d5e6f
  • optionIdstring (uuid)required

    UUID of the option (must belong to the experience in the path).

    Example:
    3d3f9c2a-1b2c-4d5e-8f90-a1b2c3d4e5f6
  • slotIdstring (uuid)required

    UUID of the availability slot (must belong to the option in the path).

    Example:
    6a5b4c3d-2e1f-4a9b-8c7d-6e5f4a3b2c1d

Request bodyapplication/json

  • reasonstringnullable

    Free-text cancellation reason, recorded on every cancelled booking's cancellation details and surfaced in guest notifications.

    Example:
    Bad weather

Responses

200object

Slot cancelled.

  • slotIdstring (uuid)

    The cancelled slot's id.

    Example:
    6a5b4c3d-2e1f-4a9b-8c7d-6e5f4a3b2c1d
  • cancelledBookingIdsstring (uuid)[]

    IDs of the live bookings that were cancelled (ACCEPTED/PENDING → CANCELLED, ON_HOLD → EXPIRED). Empty when the slot had no live bookings.

Response 200json
{
  "slotId": "6a5b4c3d-2e1f-4a9b-8c7d-6e5f4a3b2c1d",
  "cancelledBookingIds": [
    "b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e"
  ]
}

Errors

400

Validation failed. Inspect errors[].field and errors[].code.

401

Missing or invalid X-API-Key header.

403

The API key is valid but not allowed to perform this action on this resource.

404

The resource does not exist or belongs to another partner (existence is not leaked across partners).

Error body
  • typestring

    Error class.

    Allowed values:
    validation_errorclient_errorserver_error
    Example:
    validation_error
  • errorsobject[]
    Child fields
    • codestring

      Machine-readable error code.

      Example:
      required
    • fieldstringnullable

      Offending field, or null/'general' for non-field errors.

      Example:
      startTime
    • messagestring

      Human-readable message.

      Example:
      This field is required.
Response 400json
{
  "type": "validation_error",
  "errors": [
    {
      "code": "required",
      "field": "startTime",
      "message": "This field is required."
    }
  ]
}