agency-board
DELETE /v1/agency/boards/{boardId}/invites/{inviteId}
Revoke a share link, and everybody who joined through it.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X DELETE https://api.zinndigital.com/v1/agency/boards/{boardId}/invites/{inviteId} \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
⛔⛔ **This cascades.** Revoking a link also removes the board seats that link created, and the response says how many. That is deliberate and it is what separates revocation from expiry: expiry is a door closing, and nobody already inside is turned out; revocation is *"that link went somewhere it should not have"*, which a closed door does not answer.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
boardId (path) | Uuid | 是 | Project board ID (UUIDv7). |
inviteId (path) | Uuid | 是 | Board share-link ID (UUIDv7). Not the token — see `BoardShareToken`. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
revoked | boolean | 是 | — |
seats_removed | integer | 是 | How many board seats the revocation removed. Reported rather than swallowed: a silent side effect on a destructive action is how somebody removes four people believing they only… |
此端点可能返回的错误
401 · 403 · 404