Axuz Developers

PUT /me/board-pins/{boardId}

Pina o board (vai para o fim). Idempotente (200 se ja estava pinado)

  • Acesso: Login
  • 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`.

— PUT /me/board-pins/{boardId}. 200 PinnedBoard (idempotente); 404 board invisível; 422 too many pins (max 50); 503.

Parâmetros

NomeEmTipoObrigatórioDescrição
boardIdpathstringsim

Corpo da requisição

Corpo JSON. O schema detalhado deste endpoint ainda não está tipado na spec; veja a descrição da operação.

application/json

NomeTipoObrigatórioDescrição
(corpo)objectnão
{}

Respostas

200

pinado

NomeTipoObrigatórioDescrição
board_idstring<uuid>sim
team_idstring<uuid>sim
namestringsim
avatarBoardAvatar | nullsim
avatar.file_idstring<uuid>sim
avatar.content_urlstringsim
emojistring | nullsim
coverBoardCover | nullsim
cover.file_idstring<uuid> | nullsim
cover.positionintegersim
cover.coloroneOfsim
cover.content_urlstring | nullsim

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

timeline_idstring<uuid> | nullsim
effective_viewstringsim

override do usuario no board > conta > default do board > kanban

enum: "kanban", "list", "timeline", "calendar", "table"

positionintegersim

ordem do pin (1..N); nos recentes, sempre 0

opened_atstring<date-time>não

so em /me/recent-boards

400

boardId invalido

401

sem sessao

404

board invisivel/inexistente/de outro tenant/de canal sem acesso (corpo identico board not found)

422

teto de 50 pins (too many pins (max 50))

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

axuz_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/me/board-pins/BOARD_ID' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

const res = await fetch("https://api-workspace.axuz.net/me/board-pins/BOARD_ID", {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
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/me/board-pins/BOARD_ID",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={},
    timeout=30,
)
res.raise_for_status()
print(res.json())