Skip to content
XOS Developers

Delete a site plan

Places module

DELETE/site-plans/{id}sitePlans.delete

A site plan drawing for a venue. Soft-deletes the site plan: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability places.site_plan.write.
  • OAuth scopes: places.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

sitePlans.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the site plan.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/site-plans/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.sitePlans.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.site_plans.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos site-plans delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f