PATCH /teams/{teamId}/boards/{id}
PATCH do board agora tambem aceita capa, avatar e emoji (mesma transacao do nome/descricao)
- 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`.
— PATCH /teams/{teamId}/boards/{id}. 200/400/404/500. Motivo: rename. Gate: scope tasks do canal do board (W-012 S5; invisível → 404). Efeito: 1-3 SELECT (gate) + 1 UPDATE. Fluxo: UI edit.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes | |
id | path | string | yes |
Request body
application/json · Required
| Name | Type | Required | Description |
|---|---|---|---|
name | string | no | |
description | string | no | |
cover_file_id | string<uuid> | no | |
cover_position | integer | no | |
cover_color | oneOf | no | |
clear_cover | boolean | no | apaga arquivo, posicao e cor da capa |
avatar_file_id | string<uuid> | no | |
clear_avatar | boolean | no | |
emoji | string | no | |
clear_emoji | boolean | no |
{
"name": "string",
"description": "string",
"cover_file_id": "00000000-0000-0000-0000-000000000000",
"cover_position": 1,
"cover_color": "string",
"clear_cover": true,
"avatar_file_id": "00000000-0000-0000-0000-000000000000",
"clear_avatar": true,
"emoji": "string",
"clear_emoji": true
}Responses
200
board atualizado
| 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 (nothing to update), campo invalido, clear_x junto de valor do mesmo grupo
401
Sem credencial valida
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
404
board invisivel
413
imagem acima do teto
422
arquivo invalido
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 PATCH 'https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID' \
-H "Authorization: Bearer $AXUZ_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","description":"string","cover_file_id":"00000000-0000-0000-0000-000000000000","cover_position":1,"cover_color":"string","clear_cover":true,"avatar_file_id":"00000000-0000-0000-0000-000000000000","clear_avatar":true,"emoji":"string","clear_emoji":true}'Node.js
const res = await fetch("https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID", {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"description": "string",
"cover_file_id": "00000000-0000-0000-0000-000000000000",
"cover_position": 1,
"cover_color": "string",
"clear_cover": true,
"avatar_file_id": "00000000-0000-0000-0000-000000000000",
"clear_avatar": true,
"emoji": "string",
"clear_emoji": true
}),
});
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(
"PATCH",
"https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
json={
"name": "string",
"description": "string",
"cover_file_id": "00000000-0000-0000-0000-000000000000",
"cover_position": 1,
"cover_color": "string",
"clear_cover": True,
"avatar_file_id": "00000000-0000-0000-0000-000000000000",
"clear_avatar": True,
"emoji": "string",
"clear_emoji": True,
},
timeout=30,
)
res.raise_for_status()
print(res.json())