Create a site plan
Places module
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.
- Requires the capability places.site_plan.write.
- OAuth scopes: places.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: SitePlanCreate
| Field | Type | Required | Description |
|---|---|---|---|
| venue_id | string (uuid) | null | No | Identifier of the venue drawn. |
| title | string | Yes | Site plan title.Constraints: length 1 to 300 |
| project_id | string (uuid) | Yes | Identifier of the project. |
| image_uri | string | Yes | Where the drawing is stored.Constraints: 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"
}Response 201: SitePlan
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the site plan. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| venue_id | string (uuid) | null | Yes | Identifier of the venue drawn. |
| title | string | Yes | Site plan title.Constraints: length 1 to 300 |
| project_id | string (uuid) | Yes | Identifier of the project. |
| image_uri | string | Yes | Where the drawing is stored.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",
"title": "Festival Layout",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"image_uri": "plans/ground.png"
}Code samples
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"}'