Skip to content
XOS Developers

Delete a capability document

Places module

DELETE/capability-documents/{id}capabilityDocuments.delete

A venue capability document with a validity window. A frozen document cannot change. Soft-deletes the capability document: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

capabilityDocuments.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the capability document.

Response 204: no body.

Code samples

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