Inbox

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

Mark a conversation read, or archive it.

所有 Inbox 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

您的组织 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