marketplace
POST /v1/marketplace/conversations/{conversation_id}/messages
Reply in a thread, as whichever side of it you are on.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/marketplace/conversations/{conversation_id}/messages \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "body": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
docs/147 §5. The same contact policy as every other marketplace message; on a pre-sales thread attachments are refused.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
conversation_id (path) | string | はい | — |
org_id (query) | string | いいえ | Which of your organizations is replying. Naming one you do not belong to is 403. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | string | はい | — |
body | string | はい | What the reader sees — the masked form where the policy masked it. The original is always kept in the order record and is what a dispute reads; it is not in this payload, because… |
mine | boolean | はい | — |
from_staff | boolean | いいえ | — |
source_locale | string | いいえ | BCP-47. Participants write in their own language; a message is translated FOR THE READER and the original is always shown, never replaced. |
masked | boolean | いいえ | — |
policy_notice | string | いいえ | A message KEY, rendered in every locale by the client. Set only for the SENDER of a masked message — telling the recipient "they tried to give you an email address" would be an… |
held | boolean | いいえ | Only on the send response. The one case where reporting "sent" would be a lie. |
created_at | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422