Update a site plan
Places module
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.
- Requires the capability places.site_plan.write.
- OAuth scopes: places.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the site plan. |
Request body: SitePlanUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| title | string | No | Site plan title.Constraints: length 1 to 300 |
| venue_id | string (uuid) | null | No | Identifier of the venue drawn. |
| image_uri | string | No | Where the drawing is stored.Constraints: length 1 to 2000 |
{
"title": "Festival Layout",
"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"image_uri": "plans/ground.png"
}Response 200: 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 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