Skip to content
XOS Developers

Delete a record

Work module

DELETE/records/{id}records.delete

A record of any of the 26 kinds. Kind-specific attributes live in 1:1 extension tables keyed by `record_id`. Soft-deletes the record: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

records.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the record.

Response 204: no body.

Code samples

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