Hanzo
OpenapiCommerce

Change part of a disclosure

A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.

PATCH /v1/commerce/disclosure/{disclosureid}

Addresshttps://api.hanzo.ai/v1/commerce/disclosure/{disclosureid}
MethodPATCH
Operationpatch_commerce_disclosure_by_disclosureid
AuthAuthorization: Bearer $HANZO_API_KEY

A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver. The hash LOOKS like a field you set and is in fact derived, but only on update: a freshly created disclosure keeps whatever hash the caller sent until the first replace or patch recomputes it, so a new row's hash attests to nothing. This kind lives in commerce's demo tree — a live writable resource in your tenant's real store that nothing else in commerce reads. 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 disclosure, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.

Request

1 field.

FieldInTypeRequiredDescription
disclosureidpathstringyes

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 disclosure update <disclosureid>

Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page