Skip to content

Update a space

Places module

PATCH/spaces/{id}spaces.update

A space within a venue. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability places.space.write.
  • OAuth scopes: places.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

spaces.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the space.

Request body: SpaceUpdate

spaces.update: SpaceUpdate
FieldTypeRequiredDescription
namestringNoSpace name.Constraints: length 1 to 300
capacityinteger | nullNoRated occupant capacity.Constraints: range 0 to any
area_sq_ftnumber | nullNoFloor area in square feet.
uridUrid | nullNo
descriptionstring | nullNoWhat the space is used for.Constraints: length 1 to 2000
{
  "name": "North Lawn",
  "capacity": 2500,
  "area_sq_ft": 18000,
  "description": "Backstage green room for talent."
}

Response 200: Space

spaces.update: Space
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the space.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
venue_idstring (uuid)YesIdentifier of the venue.
namestringYesSpace name.Constraints: length 1 to 300
capacityinteger | nullYesRated occupant capacity.Constraints: range 0 to any
area_sq_ftnumber | nullYesFloor area in square feet.
uridUrid | nullYes
descriptionstring | nullYesWhat the space is used for.Constraints: length 1 to 2000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "North Lawn",
  "capacity": 2500,
  "area_sq_ft": 18000,
  "urid": "4000.01.01",
  "description": "Backstage green room for talent."
}

Code samples

curl -X PATCH "$XOS_BASE_URL/spaces/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"name":"North Lawn","capacity":2500,"area_sq_ft":18000,"description":"Backstage green room for talent."}'
const { data, etag } = await xos.spaces.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "North Lawn",
    "capacity": 2500,
    "area_sq_ft": 18000,
    "description": "Backstage green room for talent."
  }, { ifMatch: etag });
response = xos.spaces.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "North Lawn", "capacity": 2500, "area_sq_ft": 18000, "description": "Backstage green room for talent."}, if_match=etag)
xos spaces update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"North Lawn","capacity":2500,"area_sq_ft":18000,"description":"Backstage green room for talent."}' --if-match auto