agency-board

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

Choose whether the client can see this file.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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 у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Параметри

Назва	Тип	Обов'язкове	Що це таке
`boardId (path)`	`Uuid`	Так	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Так	Board card ID (UUIDv7).
`attachmentId (path)`	`Uuid`	Так	Board card attachment ID (UUIDv7).

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`visibility`	`AgencyBoardVisibility`	Так	Who 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…

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`Uuid`	Так	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Так	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`filename`	`string`	Так	—
`content_type`	`string`	Ні	—
`size_bytes`	`integer`	Так	—
`visibility`	`AgencyBoardVisibility`	Ні	Who 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_state`	`AgencyBoardAttachmentScanState`	Так	Where 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…
`downloadable`	`boolean`	Так	⭐ 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_by`	`AgencyBoardActor`	Ні	—
`created_at`	`string`	Ні	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422

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