Axuz Developers

PUT /me/board-pins/order

Define a ordem dos pins

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

Os ids listados ficam nas primeiras posicoes, na ordem dada; pins nao citados (inclusive os ocultos por falta de acesso) mantem a ordem relativa e vem depois.

Parâmetros

Sem parâmetros.

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
board_idsarray<string<uuid>>sim
{
  "board_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Respostas

200

ordem gravada: {items: [...]} como no GET

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

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

items[].timeline_idstring<uuid> | nullsim
items[].effective_viewstringsim

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

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

items[].positionintegersim

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

items[].opened_atstring<date-time>não

so em /me/recent-boards

400

ids invalidos ou repetidos

401

sem sessao

422

board que o usuario nao pinou (board is not pinned)

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

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/order' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"board_ids":["00000000-0000-0000-0000-000000000000"]}'

Node.js

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