Create a site plan pin

Módulo Places

POST/site-plan-pinssitePlanPins.create

A pin on a site plan. Creates a site plan pin. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad places.site_plan.write.
Alcances de OAuth: places.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: SitePlanPinCreate

sitePlanPins.create: SitePlanPinCreate
Campo	Tipo	Obligatorio	Descripción
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	No	Identifier of the zone the pin marks.
record_id	string (uuid) \| null	No	Identifier of the record the pin marks.

{
  "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"
}

Respuesta 201: SitePlanPin

sitePlanPins.create: 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 POST "$XOS_BASE_URL/site-plan-pins" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"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"}'

const { data } = await xos.sitePlanPins.create({
    "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"
  });

response = xos.site_plan_pins.create({"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"})

xos site-plan-pins create --data '{"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"}'