Blocks
Owner stays, maintenance and other deliberate closures. A block has an id and an owner; only its creator may change it.
List blocks
Returns owner and maintenance blocks. from and to match any block overlapping the window. Set mine_only=true for blocks your integration created.
query Parameters
idsComma-separated list of resource ids to fetch.
created_afterOnly records created strictly after this instant (RFC 3339).
created_beforeOnly records created strictly before this instant (RFC 3339).
updated_afterOnly records modified strictly after this instant (RFC 3339). Use this for delta syncs.
updated_beforeOnly records modified strictly before this instant (RFC 3339).
limitPage size, 1-200.
cursorOpaque cursor from a previous response. Pass pagination.next_cursor back verbatim.
property_idOnly blocks on this property.
fromBlocks overlapping on or after this date (YYYY-MM-DD).
toBlocks overlapping on or before this date (YYYY-MM-DD).
mine_onlyReturn only the blocks created by your own integration.
Headers
X-Noe-AppYour integration key. Verified against the key you authenticated with; a mismatch is rejected.
List blocks › Responses
A cursor-paginated page of blocks.
Create a block
Blocks the given nights and closes them on the connected channels. Your integration owns the block, which is what allows you to update or delete it.
Headers
Idempotency-KeyAny unique string (a UUID works). Retrying with the same key replays the original response instead of performing the write twice.
X-Noe-AppYour integration key. Verified against the key you authenticated with; a mismatch is rejected.
Create a block › Request Body
property_idProperty to block.
start_dateFirst blocked night (YYYY-MM-DD).
end_dateLast blocked night (YYYY-MM-DD), inclusive.
last_day_is_checkoutWhen true, end_date is a DEPARTURE day rather than a blocked night: the occupant leaves that morning and the date stays sellable as an arrival.
reason_typeFree-form category, e.g. owner or maintenance.
reasonHuman-readable note.
Create a block › Responses
The created block.
idobjectproperty_idstart_dateFirst blocked night.
end_dateLast blocked night.
last_day_is_checkoutWhen true the final day is a check-out only, so that night stays bookable by an arriving guest.
reason_typereasoneditableTrue when your integration created this block, which is also the only case in which you may modify or delete it.
created_atupdated_atRetrieve a block
Returns a single block.
path Parameters
idBlock id.
Headers
X-Noe-AppYour integration key. Verified against the key you authenticated with; a mismatch is rejected.
Retrieve a block › Responses
The requested block.
idobjectproperty_idstart_dateFirst blocked night.
end_dateLast blocked night.
last_day_is_checkoutWhen true the final day is a check-out only, so that night stays bookable by an arriving guest.
reason_typereasoneditableTrue when your integration created this block, which is also the only case in which you may modify or delete it.
created_atupdated_atDelete a block
Removes the block and reopens those nights. Only blocks your integration created can be deleted.
path Parameters
idBlock id.
Headers
Idempotency-KeyAny unique string (a UUID works). Retrying with the same key replays the original response instead of performing the write twice.
X-Noe-AppYour integration key. Verified against the key you authenticated with; a mismatch is rejected.
Delete a block › Responses
Deletion acknowledgement.
idobjectdeletedUpdate a block
Only blocks your integration created can be modified.
path Parameters
idBlock id.
Headers
Idempotency-KeyAny unique string (a UUID works). Retrying with the same key replays the original response instead of performing the write twice.
X-Noe-AppYour integration key. Verified against the key you authenticated with; a mismatch is rejected.
Update a block › Request Body
start_dateend_datelast_day_is_checkoutreason_typereasonUpdate a block › Responses
The updated block.
idobjectproperty_idstart_dateFirst blocked night.
end_dateLast blocked night.
last_day_is_checkoutWhen true the final day is a check-out only, so that night stays bookable by an arriving guest.
reason_typereasoneditableTrue when your integration created this block, which is also the only case in which you may modify or delete it.
created_atupdated_atCreate blocks in bulk
Accepts up to 100 blocks. Returns 207 with a per-item result, so an item that cannot be applied does not stop the rest. Every item must be schema-valid: one malformed item rejects the whole payload with 400.
Headers
Idempotency-KeyAny unique string (a UUID works). Retrying with the same key replays the original response instead of performing the write twice.
X-Noe-AppYour integration key. Verified against the key you authenticated with; a mismatch is rejected.
Create blocks in bulk › Request Body
Create blocks in bulk › Responses
Per-item results, in request order.
One entry per submitted item, in request order. An item that fails while being APPLIED does not stop the others, so inspect every entry. A payload that fails schema validation is rejected whole, with a single 400.