Hanzo
OpenapiCommerce

Change part of a submission

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

PATCH /v1/commerce/submission/{submissionid}

Addresshttps://api.hanzo.ai/v1/commerce/submission/{submissionid}
MethodPATCH
Operationpatch_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. Loads the stored row and decodes the body OVER it, so only the fields the body names change and everything else keeps its stored value — the difference from the full replace, which clears what it is not told. Answers the merged row. An id absent from the caller org's namespace is 404 and a body that fails to decode is 400. 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 update <submissionid>

Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page