marketplace
POST /v1/marketplace/orders/{sale_id}/messages/preview
Assess a draft before it is sent — the inline nudge.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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> }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
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.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
sale_id (path) | string | はい | — |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
body | string | はい | — |
locale | string | いいえ | — |
attachments | object[] | いいえ | 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. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
action | string<allow, nudge, flag, mask, hold> | はい | 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 | はい | — |
kinds | string[] | いいえ | What was detected, which is what makes the false-positive rate actionable. |
nudge | string | いいえ | A message KEY for the inline warning, or empty. Never a sentence. |
このエンドポイントが返すエラー
401 · 404