marketplace
POST /v1/marketplace/orders/{sale_id}/messages/preview
Assess a draft before it is sent — the inline nudge.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
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 в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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