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, за да можете да видите действителния отговор. Отворете този крайpoint в 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`	Не	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

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