Inbox

POST `/v1/inbox/threads/{threadKey}`

Mark a conversation read, or archive it.

すべての Inbox エンドポイント

認証

ベアラートークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

組織 ID を入力する場所

このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。

組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X POST https://api.zinndigital.com/v1/inbox/threads/{threadKey} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "action": <string<read, archive>> }'

ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

A POST and not a GET, because a read receipt is a write — a GET that mutates is one a prefetcher, a crawler or the back button fires on the customer's behalf.

パラメータ

名前	タイプ	必須	これがその内容です
`threadKey (path)`	`string`	はい	—
`org_id (query)`	`Uuid`	いいえ	The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agen…

リクエスト本文

名前	タイプ	必須	これがその内容です
`action`	`string<read, archive>`	はい	—

返信

名前	タイプ	必須	これがその内容です
`marked_read`	`integer`	いいえ	—
`archived`	`integer`	いいえ	—
`unread`	`integer`	いいえ	—
`capped`	`boolean`	いいえ	—

このエンドポイントが返すエラー

401 · 403 · 422