API reference

GET /properties

Return one stable page of properties.

GET /properties/{propertyId}

Return one property from the API key workspace.

PUT /properties/{propertyId}

Replace the writable details of one property. This endpoint requires the properties:write scope. Only name and timezone are writable; the other read fields are ignored when sent back.

The response is the updated property record. On a channel-connected property the change also queues to the channel sync outbox and propagates to connected channels asynchronously. An archived property must be restored in the dashboard before editing.

Send an Idempotency-Key header to make retries safe: a repeated PUT with the same key and the same payload returns the original record and applies nothing twice; the same key with a different payload fails with 409 idempotency_key_reused. A write that lands while a channel sync is still in progress fails with 409 sync_in_progress; retry once the sync completes.

GET /properties/{propertyId}/rooms

Return one stable page of room types for one property, each with its physical units. Inactive records stay in the response with status inactive.

GET /properties/{propertyId}/rate-plans

Return one stable page of rate plans for one property. This endpoint requires the rate-plans:read scope.

PUT /properties/{propertyId}/rate-plans

Create and update rate plans for one property. This endpoint requires the rate-plans:write scope. The body is an array of rate plan entries shaped like the read rows.

Each entry is an upsert keyed by id: an entry with an id replaces that plan’s fields — nights that inherit the base rate follow the new rate — and an entry without an id creates a plan under inventoryPool.id. Plans not mentioned stay untouched. Changes queue to the channel sync outbox and propagate to connected channels asynchronously.

Send an Idempotency-Key header to make retries safe: a repeated PUT with the same key and the same payload returns the original summary and applies nothing twice; the same key with a different payload fails with 409 idempotency_key_reused. A write that lands while a channel sync is still in progress fails with 409 sync_in_progress; retry once the sync completes.

GET /properties/{propertyId}/calendar

Return per-day availability, lowest rate, and minimum stay for every active inventory pool of one property. This endpoint requires the calendar:read scope. The range spans at most 92 days and defaults to the next 31 days in the property time zone. Dates accept years 1 through 9999. The response is limited to 2000 rows (dates × active pools); larger requests fail with calendar_result_too_large, so narrow the range or pass pool_id.

availableUnits subtracts reservations and availability blocks from the sellable count and is 0 on closed dates. rate and minStay come from the lowest-priced sellable rate plan; both are null when no active plan sells the date, and stopSell is true when every active plan is stop-sold.

PUT /properties/{propertyId}/calendar

Bulk-update per-day availability, rates, and restrictions for one property. This endpoint requires the calendar:write scope. The body is an array of day entries shaped like the read rows.

Each entry is an upsert: days not mentioned stay untouched, and a null rate or minStay leaves the stored value unchanged. Without ratePlanId an entry writes every active rate plan on the pool; with it, only that plan’s nightly state changes. Entries for the same pool and date may target different rate plans, but their pool-level fields (availableUnits, closed) must agree, and a pool-level entry cannot share a date with targeted entries. availableUnits is the target availability — reservations and blocks are added back when the sellable count is stored. A request can form at most 90 disjoint date ranges in total; batch genuinely sparse updates into multiple requests. Changes queue to the channel sync outbox and propagate to connected channels asynchronously.

Send an Idempotency-Key header to make retries safe: a repeated PUT with the same key and the same payload returns the original summary and applies nothing twice; the same key with a different payload fails with 409 idempotency_key_reused.

GET /reservations

Return one stable page of reservations.

GET /reservations/{reservationId}

Return one reservation from the API key workspace.

POST /reservations

Create one direct reservation. This endpoint requires the reservations:write scope. The body mirrors the read row: guest, stay, occupancy, and one items line with the ratePlanId to book.

The rate plan, its inventory pool, and the property must be active, and a channel-mapped (OTA) rate plan cannot take a direct booking. The total prices from the plan’s base rate for every night. Inventory allocates inside the same transaction and the availability change queues to the channel sync outbox asynchronously. Owner (entitlement) inventory cannot be booked through this endpoint.

Capacity failures return 400 insufficient_inventory. Send an Idempotency-Key header to make retries safe: a repeated POST with the same key and the same payload returns the original reservation instead of booking twice; the same key with a different payload fails with 409 idempotency_key_reused.

PUT /reservations/{reservationId}

Replace the writable fields of one direct reservation. This endpoint requires the reservations:write scope. The body is the same shape as the create body; the stored allocation moves to the new dates, rate plan, and room quantity, and the total reprices.

Channel reservations must be changed in the connected channel (400 channel_managed). Cancelled, started, or completed reservations cannot be changed, and reservations with assigned units or multiple item records need the dashboard.

POST /reservations/{reservationId}/cancel

Cancel one direct reservation and release its inventory. This endpoint requires the reservations:write scope. Cancelling an already cancelled reservation succeeds without changing anything.

Channel reservations must be cancelled in the connected channel (400 channel_managed), and completed reservations cannot be cancelled (400 reservation_completed). The release queues to the channel sync outbox asynchronously.

GET /tasks

Return one stable page of tasks.

POST /tasks

Create a task. Send an Idempotency-Key header to make retries safe: a repeated POST with the same key and the same payload returns 200 with the original task and creates nothing new; the same key with a different payload fails with 409 idempotency_key_reused.

GET /tasks/{taskId}

Return one task from the API key workspace.

PUT /tasks/{taskId}

Replace one task. PUT is a full replacement: an omitted status resets the task to open.

GET /conversations

Return one stable page of conversations, newest activity first.

GET /conversations/{conversationId}/messages

Return one stable page of messages in chronological order.

POST /conversations/{conversationId}/messages

Queue a reply for delivery through the channel connection. The 201 response returns the stored message. Replying fails with replies_not_supported when the connection cannot send messages, and with conversation_closed when the thread is closed.

Send an Idempotency-Key header to make retries safe: a repeated POST with the same key and the same payload returns 200 with the original message and queues nothing new; the same key with a different payload fails with 409 idempotency_key_reused.

GET /channels

Return one stable page of channel connections.

GET /webhooks

Return one stable page of webhook endpoints, newest first.

POST /webhooks

Create a webhook endpoint. The URL must be a public https:// address without embedded credentials: loopback, private, link-local, and reserved hosts are rejected at save time, and delivery re-checks DNS answers and every redirect hop before connecting.

Send an Idempotency-Key header to make retries safe. A repeated POST with the same key and the same payload returns 200 with the original endpoint and creates nothing new; the same key with a different payload fails with 409 idempotency_key_reused.

The 201 response is the only one that includes signingSecret. A replayed request returns 200 without the secret.

GET /webhooks/{webhookId}

Return one webhook endpoint from the API key workspace.

PUT /webhooks/{webhookId}

Replace the URL, description, and subscribed events of one webhook endpoint. Set enabled to change the status.

DELETE /webhooks/{webhookId}

Delete one webhook endpoint. A successful delete returns 204 with no body.

GET /webhooks/{webhookId}/deliveries

Return one stable page of delivery attempts for the endpoint, newest first.