agency-board

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

Choose whether the client can see this file.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Parâmetros

Nome	Tipo	Obrigatório	O que é
`boardId (path)`	`Uuid`	Sim	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Sim	Board card ID (UUIDv7).
`attachmentId (path)`	`Uuid`	Sim	Board card attachment ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`visibility`	`AgencyBoardVisibility`	Sim	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…

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`filename`	`string`	Sim	—
`content_type`	`string`	Não	—
`size_bytes`	`integer`	Sim	—
`visibility`	`AgencyBoardVisibility`	Não	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`	Sim	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`	Sim	⭐ 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`	Não	—
`created_at`	`string`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

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