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 that…

Ответ

Имя	Тип	Обязательно	Что это
`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 that…
`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…
`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 the…
`uploaded_by`	`AgencyBoardActor`	Нет	—
`created_at`	`string`	Нет	—

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422

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