Hanzo
OpenapiCommerce

Replace a submission outright

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,…

PUT /v1/commerce/submission/{submissionid}

Addresshttps://api.hanzo.ai/v1/commerce/submission/{submissionid}
MethodPUT
Operationput_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. This is a true REPLACEMENT, not a merge: the stored row's key is preserved, but the body is decoded onto a FRESH entity, so every field the body omits is written back as its ZERO value. Patch is the verb for changing part of a row. The id is resolved inside the caller org's own namespace and an absent one is 404 before anything is written; a body that fails to decode is 400. Answers the stored result. 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 set <submissionid>

Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page