Axuz Developers

PATCH /teams/{teamId}/boards/{id}

PATCH do board agora tambem aceita capa, avatar e emoji (mesma transacao do nome/descricao)

  • Acesso: Membro da equipe
  • Serviço: https://api-workspace.axuz.net

Autenticação aceita

  • 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.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
idpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
namestringnão
descriptionstringnão
cover_file_idstring<uuid>não
cover_positionintegernão
cover_coloroneOfnão
clear_coverbooleannão

apaga arquivo, posicao e cor da capa

avatar_file_idstring<uuid>não
clear_avatarbooleannão
emojistringnão
clear_emojibooleannão
{
  "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
}

Respostas

200

board atualizado

NomeTipoObrigatórioDescrição
coverBoardCover | nullnão
cover.file_idstring<uuid> | nullsim
cover.positionintegersim
cover.coloroneOfsim
cover.content_urlstring | nullsim

/api/teams/{team_id}/files/{file_id}/content (same-origin)

avatarBoardAvatar | nullnão
avatar.file_idstring<uuid>sim
avatar.content_urlstringsim
emojistring | nullnão

400

corpo vazio (nothing to update), campo invalido, clear_x junto de valor do mesmo grupo

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

NomeTipoObrigatórioDescrição
errorstringsim

404

board invisivel

413

imagem acima do teto

422

arquivo invalido

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

503

files_api indisponivel

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

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())