Hanzo
OpenapiCommerce

Delete a submission, keeping a recoverable copy

A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer,…

DELETE /v1/commerce/submission/{submissionid}

Addresshttps://api.hanzo.ai/v1/commerce/submission/{submissionid}
MethodDELETE
Operationdelete_commerce_submission_by_submissionid
AuthAuthorization: Bearer $HANZO_API_KEY

A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer, geography) and the form's own fields as free metadata. It carries no form id, so the link back to the form that produced it is not stored on the row. 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 submission, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.

Request

1 field.

FieldInTypeRequiredDescription
submissionidpathstringyes

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 submission rm <submissionid>

Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page