Axuz Developers

PUT /teams/{teamId}/boards/{id}/cover

Define a capa do board (mesma permissao de editar o board)

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

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.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
idpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
file_idstring<uuid>não
positionintegernão
coloroneOfnão
{
  "file_id": "00000000-0000-0000-0000-000000000000",
  "position": 1,
  "color": "string"
}

Respostas

200

board atualizado (com cover)

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

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