agency-board

PATCH /v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId}

Choose whether the client can see this file.

所有 agency-board 端点

身份验证

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

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "visibility": <AgencyBoardVisibility> }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

参数

名称类型必填内容简介
boardId (path)UuidProject board ID (UUIDv7).
cardId (path)UuidBoard card ID (UUIDv7).
attachmentId (path)UuidBoard card attachment ID (UUIDv7).

请求正文

名称类型必填内容简介
visibilityAgencyBoardVisibilityWho may see this object. `internal` is always the default. A **card** reaches the client only when it is `client` **and its column is too** — an AND, not inheritance, because th…

响应

名称类型必填内容简介
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
card_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
filenamestring
content_typestring
size_bytesinteger
visibilityAgencyBoardVisibilityWho may see this object. `internal` is always the default. A **card** reaches the client only when it is `client` **and its column is too** — an AND, not inheritance, because th…
scan_stateAgencyBoardAttachmentScanStateWhere an uploaded file is in the malware pipeline. ⛔ `clean` is the ONLY state the bytes are ever served in — `pending`, `infected` and `error` all refuse, including to the agen…
downloadableboolean⭐ Whether these bytes may be fetched right now. Computed from the scan state by the engine rather than derived by a caller — two copies of "may this leave the building" is how t…
uploaded_byAgencyBoardActor
created_atstring

此端点可能返回的错误

401 · 403 · 404 · 422