Create a site plan

Módulo Places

POST/site-planssitePlans.create

A site plan drawing for a venue. Creates a site plan. 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: SitePlanCreate

sitePlans.create: SitePlanCreate
Campo	Tipo	Obligatorio	Descripción
venue_id	string (uuid) \| null	No	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

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

Respuesta 201: SitePlan

sitePlans.create: 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 POST "$XOS_BASE_URL/site-plans" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Festival Layout","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","image_uri":"plans/ground.png"}'

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

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

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