Spaces
Update the pricing of a space
Sets the rental rate of the space, the deposit, whether it allows insurance and discount, and the time margins that block it around the booking.
spaces:writespaces:write- 120/min
- Server annotation: Idempotent
Result
generated from the schema
The internal cost, the external cost and the tax configuration are NOT part of the public contract. Note: the public record of a space does not emit its commercial policy, so what you write here cannot be read back through the API. Returns the updated space in detail.
Arguments
Space identifier.
Limits: min length 1
Rental pricing of the space, the three fields together; null clears it.
Show child attributesHide child attributes
Pricing mode.
Available options: periodPrice, fixedPrice, pricingStructure
Base rental price, as a decimal string.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Period unit of the price.
Available options: hour, day, week, month
Whether the space allows insurance.
Security deposit amount, as a decimal string; null clears it.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Whether the space allows a discount.
Time buffer reserved BEFORE the rental; null clears it together with its unit.
Limits: min 0
Unit of the preceding buffer; null only together with bufferBefore: null.
Available options: hour, day
Time buffer reserved AFTER the rental; null clears it together with its unit.
Limits: min 0
Unit of the following buffer; null only together with bufferAfter: null.
Available options: hour, day
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique space identifier.
Space name.
Internal reference of the space, useful for matching with external systems; null if it has none.
true if the space is a warehouse that manages stock and can be the main warehouse of an order; false if it is a rentable space.
Identifier of the collection it belongs to; null if it is in none.
Full collection path, for example "Estudios > Fotografía"; null if not applicable.
Building it is located in; null if not applicable.
Floor it is located on; null if not applicable.
Physical location of the space.
Show child attributesHide child attributes
Postal address; null if not recorded.
Municipality; null if not recorded.
Postal code; null if not recorded.
Country; null if not recorded.
Latitude in decimal degrees; null if not geolocated.
Longitude in decimal degrees; null if not geolocated.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
Space description; null if it has none.
Capacity in people; null if not defined.
Area in square metres; null if not defined.
Dimensions as free text; null if not defined.
Additional services available (wifi, projector...).
Fixed equipment available in the space.
Rental pricing of the space; null if not configured. The same fields that PATCH /pricing accepts.
Show child attributesHide child attributes
Pricing mode; null if not configured.
Available options: periodPrice, fixedPrice, pricingStructure
Base rental price as a decimal string; null if not configured.
Limits: pattern ^-?\d+\.\d{2}$
Period unit of the price; null if not configured.
Available options: hour, day, week, month
Whether the space allows insurance.
Whether the space allows a discount.
Security deposit amount as a decimal string; null if not set.
Limits: pattern ^-?\d+\.\d{2}$
Time buffer reserved BEFORE the rental; null if none.
Unit of the preceding buffer; null if none.
Available options: hour, day
Time buffer reserved AFTER the rental; null if none.
Unit of the following buffer; null if none.
Available options: hour, day
Custom field values by custom field identifier; the definitions are in /api.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs PATCH /api/v1/spaces/{spaceId}/pricing.
Related pages
Link to this section: Related pagesSpaces
Update the pricing of a space
Sets the rental rate of the space, the deposit, whether it allows insurance and discount, and the time margins that block it around the booking.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?