Block a period of a resource
POST /v1/resources/{id}/block
Takes the whole capacity of the resource, so a period that is already booked or held answers 409 slot_unavailable.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Identifier of the resource.
Header Parameters
Section titled “Header Parameters ”The dated API version to speak. Defaults to 2026-09-01; an unsupported value is a 400.
Example
2026-09-01Which Bookrail tool the caller is, recorded as actor.via on every event the request writes. A closed list: an unknown value is a 400. Absent means the request declared no tool.
Retry-safety key, 1 to 255 characters. The same key within 24 hours replays the first response, errors included, and never produces a second effect.
Request Body required
Section titled “Request Body required ”object
ISO 8601 instant with an explicit offset. Any offset is accepted on input; every instant is returned in UTC.
Example
2026-09-08T07:00:00ZISO 8601 instant with an explicit offset. Any offset is accepted on input; every instant is returned in UTC.
Example
2026-09-08T07:00:00ZFree-form key/value pairs stored with the object and returned untouched.
object
Responses
Section titled “ Responses ”Created.
object
Identifier of a resource_block, prefixed with blk_.
Example
blk_0198f0c2a1b47e2e9a1c0f4d5e6a7b8cIdentifier of a resource, prefixed with res_.
Example
res_0198f0c2a1b47e2e9a1c0f4d5e6a7b8cISO 8601 instant in UTC.
Example
2026-09-08T07:00:00ZISO 8601 instant in UTC.
Example
2026-09-08T07:00:00ZFree-form key/value pairs stored with the object and returned untouched.
object
The environment of the API key that created the object.
ISO 8601 instant in UTC.
Example
2026-09-08T07:00:00ZISO 8601 instant in UTC.
Example
2026-09-08T07:00:00ZHeaders
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
true when the body is the stored answer of an earlier request with the same Idempotency-Key.
Error codes: idempotency_key_reused, invalid_body, parameter_invalid, parameter_missing, unsupported_api_version.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Error codes: invalid_api_key, invalid_authorization_header, missing_api_key, revoked_api_key.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Error codes: resource_missing.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Error codes: idempotency_key_in_progress, slot_unavailable.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Error codes: internal_error.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.