Hanzo
OpenapiCommerce

Delete a note, keeping a recoverable copy

A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.

DELETE /v1/commerce/note/{noteid}

Addresshttps://api.hanzo.ai/v1/commerce/note/{noteid}
MethodDELETE
Operationdelete_commerce_note_by_noteid
AuthAuthorization: Bearer $HANZO_API_KEY

A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag. That time is the caller's own field and is distinct from the row's creation stamp; the note search filters on it, so a note written without one is a zero-time note the ops log will never surface. Removes the addressed row and answers 204 with no body. Before the live row goes it is written once more under a deleted tombstone kind, so a deletion leaves a recoverable copy rather than destroying the record outright — and a tombstone that cannot be written fails the call with 500 before anything is removed. The id is resolved inside the caller org's own namespace, so an absent or foreign id is 404. Any valid access token reaches it. The per-kind permission table has no entry for note, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.

Request

1 field.

FieldInTypeRequiredDescription
noteidpathstringyes

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo commerce note rm <noteid>

Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page