Saltar al contenido

Delete a capability document

Módulo Places

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.

  • Requiere la capacidad places.capability_document.write.
  • Alcances de OAuth: places.
  • Estados de error: 401, 404, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

capabilityDocuments.delete: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the capability document.

Respuesta 204: sin cuerpo.

Ejemplos de código

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