Spaces
Update a warehouse or space
Updates the record of a warehouse or space (send only the fields to change).
spaces:writespaces:write- 120/min
- Server annotation: Idempotent
Result
generated from the schema
tags replaces the whole list, and a tag name that does not exist CREATES it. The holding costs of the space are NOT part of the public contract and cannot be written here; for the rate there is the pricing endpoint. If another space of the account already has that name (without distinguishing upper and lower case) or that internalReference, it responds 409 conflict with errors[0]. on the field. Returns the updated space in detail.
Arguments
Space identifier.
Limits: min length 1
Space name.
Limits: min length 1
Internal reference, unique within the account; null clears it.
Space description; null clears it.
Building the space belongs to; null clears it.
Space location. Coordinates are required if the object is sent.
Show child attributesHide child attributes
Street and number.
City.
Postal code.
Country.
Latitude in decimal degrees.
Longitude in decimal degrees.
Maximum capacity in people; null clears it.
Limits: min 0
Dimensions as free text; null clears it.
Area in square metres; null clears it.
Limits: min 0
Floor the space is on; null clears it.
true if it is a warehouse that manages stock; false if it is a rentable space.
Collection the space belongs to; null removes it from any collection.
Limits: min length 1
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}.
Related pages
Link to this section: Related pagesSpaces
Update a warehouse or space
Updates the record of a warehouse or space (send only the fields to change).
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?