marketplace
POST /v1/marketplace/orders/{sale_id}/messages/preview
Assess a draft before it is sent — the inline nudge.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
sale_id (path) | string | Ja | — |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
body | string | Ja | — |
locale | string | Nein | — |
attachments | object[] | Nein | 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. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
action | string<allow, nudge, flag, mask, hold> | Ja | 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 | Ja | — |
kinds | string[] | Nein | What was detected, which is what makes the false-positive rate actionable. |
nudge | string | Nein | A message KEY for the inline warning, or empty. Never a sentence. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 404