marketplace
POST /v1/marketplace/orders/{sale_id}/messages/preview
Assess a draft before it is sent — the inline nudge.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/marketplace/orders/{sale_id}/messages/preview \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "body": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
docs/133 D26, the top rung of the ladder and the one that does most of the work: most circumvention is naive, and telling someone once, before they send, that the platform holds the money and the guarantee stops most of it. Writes nothing and counts nothing, so it is safe to call on blur. Storing a policy event for a draft somebody then edits would also poison the false-positive rate with messages that were never sent. `nudge` is a message KEY, not a sentence — it is rendered in every locale by the client.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
sale_id (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
body | string | Yes | — |
locale | string | No | — |
attachments | object[] | No | Refused entirely on a pre-sales thread: an attachment bypasses text scanning and we have no OCR, so on the one surface where nobody has paid there are no files. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
action | string<allow, nudge, flag, mask, hold> | Yes | The rung the ladder chose. There is no rung that refuses to send — the hardest action is holding for review, and at high confidence the action is on the ACCOUNT rather than on t… |
confidence | integer | Yes | — |
kinds | string[] | No | What was detected, which is what makes the false-positive rate actionable. |
nudge | string | No | A message KEY for the inline warning, or empty. Never a sentence. |
Errors this endpoint can return
401 · 404