PUT /me/board-pins/{boardId}
Pina o board (vai para o fim). Idempotente (200 se ja estava pinado)
- Access: Signed in
- 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`.
— PUT /me/board-pins/{boardId}. 200 PinnedBoard (idempotente); 404 board invisível; 422 too many pins (max 50); 503.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
boardId | path | string | yes |
Request body
Corpo JSON. O schema detalhado deste endpoint ainda não está tipado na spec; veja a descrição da operação.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
(corpo) | object | no |
{}Responses
200
pinado
| Name | Type | Required | Description |
|---|---|---|---|
board_id | string<uuid> | yes | |
team_id | string<uuid> | yes | |
name | string | yes | |
avatar | BoardAvatar | null | yes | |
avatar.file_id | string<uuid> | yes | |
avatar.content_url | string | yes | |
emoji | string | null | yes | |
cover | BoardCover | null | yes | |
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) |
timeline_id | string<uuid> | null | yes | |
effective_view | string | yes | override do usuario no board > conta > default do board > kanban enum: |
position | integer | yes | ordem do pin (1..N); nos recentes, sempre 0 |
opened_at | string<date-time> | no | 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.
| 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
axuz_api indisponivel
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
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())