Update a site plan

Módulo Places

PATCH/site-plans/{id}sitePlans.update

A site plan drawing for 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.

Requiere la capacidad places.site_plan.write.
Alcances de OAuth: places.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

sitePlans.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the site plan.

Cuerpo de la solicitud: SitePlanUpdate

sitePlans.update: SitePlanUpdate
Campo	Tipo	Obligatorio	Descripción
title	string	No	Site plan title.Restricciones: length 1 to 300
venue_id	string (uuid) \| null	No	Identifier of the venue drawn.
image_uri	string	No	Where the drawing is stored.Restricciones: length 1 to 2000

{
  "title": "Festival Layout",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "image_uri": "plans/ground.png"
}

Respuesta 200: SitePlan

sitePlans.update: SitePlan
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the site plan.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
venue_id	string (uuid) \| null	Sí	Identifier of the venue drawn.
title	string	Sí	Site plan title.Restricciones: length 1 to 300
project_id	string (uuid)	Sí	Identifier of the project.
image_uri	string	Sí	Where the drawing is stored.Restricciones: 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",
  "title": "Festival Layout",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "image_uri": "plans/ground.png"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/site-plans/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 '{"title":"Festival Layout","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","image_uri":"plans/ground.png"}'

const { data, etag } = await xos.sitePlans.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "title": "Festival Layout",
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "image_uri": "plans/ground.png"
  }, { ifMatch: etag });

response = xos.site_plans.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"title": "Festival Layout", "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "image_uri": "plans/ground.png"}, if_match=etag)

xos site-plans update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"title":"Festival Layout","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","image_uri":"plans/ground.png"}' --if-match auto