PUT /teams/{teamId}/boards/{id}/cover
Define a capa do board (mesma permissao de editar o board)
- Access: Team member
- Service:
https://api-workspace.axuz.net
Accepted authentication
sessionCookie— Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.bearerSession— JWT de acesso da sessão em `Authorization: Bearer`.
Ao menos um campo. file_id troca a imagem (e, sem position, volta a posicao para 50); position ajusta so o recorte; color (string) define a cor, color:null a limpa.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes | |
id | path | string | yes |
Request body
application/json · Required
| Name | Type | Required | Description |
|---|---|---|---|
file_id | string<uuid> | no | |
position | integer | no | |
color | oneOf | no |
{
"file_id": "00000000-0000-0000-0000-000000000000",
"position": 1,
"color": "string"
}Responses
200
board atualizado (com cover)
| Name | Type | Required | Description |
|---|---|---|---|
cover | BoardCover | null | no | |
cover.file_id | string<uuid> | null | yes | |
cover.position | integer | yes | |
cover.color | oneOf | yes | |
cover.content_url | string | null | yes | /api/teams/{team_id}/files/{file_id}/content (same-origin) |
avatar | BoardAvatar | null | no | |
avatar.file_id | string<uuid> | yes | |
avatar.content_url | string | yes | |
emoji | string | null | no |
400
corpo vazio/invalido, position fora de 0..100, cor invalida
401
sem sessao
403
nao e membro do team (ou membro de outro tenant)
404
board invisivel/inexistente/de outro tenant
413
imagem acima de 10 MB
422
arquivo invalido (ver Arquivos)
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
Erro interno. Tente de novo com backoff; reporte o X-Request-Id.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
503
files_api indisponivel
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
curl
curl -sS -X PUT 'https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/cover' \
-H "Authorization: Bearer $AXUZ_TOKEN" \
-H "Content-Type: application/json" \
-d '{"file_id":"00000000-0000-0000-0000-000000000000","position":1,"color":"string"}'Node.js
const res = await fetch("https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/cover", {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"file_id": "00000000-0000-0000-0000-000000000000",
"position": 1,
"color": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());Python
import os
import requests
res = requests.request(
"PUT",
"https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/cover",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
json={
"file_id": "00000000-0000-0000-0000-000000000000",
"position": 1,
"color": "string",
},
timeout=30,
)
res.raise_for_status()
print(res.json())