Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

Availability Exception → Create

AI-generated

Summary

Create a new availability exception for a listing.

Inputs

  • listingId (required) — ID of the listing to create exception for
  • simplify — Whether to return a simplified version of the response
  • availabilityExceptionFields — Choose from the list, or specify IDs using an expression
  • listingFields — Choose from the list, or specify IDs using an expression
  • available — Whether the exception creates a time range available for booking
  • allDay — Whether to create a full day exception (00:00:00 UTC to next day 00:00:00 UTC)
  • date (required) — Date for the exception (will span from 00:00:00 UTC to next day 00:00:00 UTC). Learn more
  • start (required) — Start date and time of the exception. Learn more
  • end (required) — End date and time (exclusive) of the exception. Learn more
  • seats — How many seats to make available during this time period

Output shape

a single AvailabilityException record (full or simplified based on simplify)

Returns the created exception; if simplify is true only selected fields are included.

Examples

Example 1: Add a 2‑hour time‑slot with 5 seats on a specific date

listingId: 550e8400‑e29b‑41d4‑a716‑446655440000, start: 2024‑10‑01T10:00:00Z, end: 2024‑10‑01T12:00:00Z, seats: 5, simplify: false

Example 2: Create a full‑day exception for all seats

listingId: 550e8400‑e29b‑41d4‑a716‑446655440000, date: 2024‑11‑15, allDay: true, simplify: true, availabilityExceptionFields: ["start","end","seats"]

Example 3: Mark a range as available for booking

listingId: 550e8400‑e29b‑41d4‑a716‑446655440000, start: 2024‑12‑01T09:00:00Z, end: 2024‑12‑01T17:00:00Z, available: true, simplify: false

Links

Discussion