Update a site plan pin

Módulo Places

PATCH/site-plan-pins/{id}sitePlanPins.update

A pin on a site plan. 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

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

Cuerpo de la solicitud: SitePlanPinUpdate

sitePlanPins.update: SitePlanPinUpdate
Campo	Tipo	Obligatorio	Descripción
label	string	No	Pin label.Restricciones: length 1 to 300
x	number	No	Horizontal position, 0 to 1.
y	number	No	Vertical position, 0 to 1.
zone_id	string (uuid) \| null	No	Identifier of the zone the pin marks.
record_id	string (uuid) \| null	No	Identifier of the record the pin marks.

{
  "label": "First Aid",
  "x": 0.42,
  "y": 0.71,
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 200: SitePlanPin

sitePlanPins.update: SitePlanPin
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the site plan pin.
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.
site_plan_id	string (uuid)	Sí	Identifier of the site plan.
label	string	Sí	Pin label.Restricciones: length 1 to 300
x	number	Sí	Horizontal position, 0 to 1.
y	number	Sí	Vertical position, 0 to 1.
zone_id	string (uuid) \| null	Sí	Identifier of the zone the pin marks.
record_id	string (uuid) \| null	Sí	Identifier of the record the pin marks.

{
  "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",
  "site_plan_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "label": "First Aid",
  "x": 0.42,
  "y": 0.71,
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/site-plan-pins/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 '{"label":"First Aid","x":0.42,"y":0.71,"zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data, etag } = await xos.sitePlanPins.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "label": "First Aid",
    "x": 0.42,
    "y": 0.71,
    "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });

response = xos.site_plan_pins.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"label": "First Aid", "x": 0.42, "y": 0.71, "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)

xos site-plan-pins update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"label":"First Aid","x":0.42,"y":0.71,"zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto