PUT /me/board-pins/order
Define a ordem dos pins
- 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`.
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.
Parameters
No parameters.
Request body
application/json · Required
| Name | Type | Required | Description |
|---|---|---|---|
board_ids | array<string<uuid>> | yes |
{
"board_ids": [
"00000000-0000-0000-0000-000000000000"
]
}Responses
200
ordem gravada: {items: [...]} como no GET
| Name | Type | Required | Description |
|---|---|---|---|
items | array<PinnedBoard> | no | |
items[].board_id | string<uuid> | yes | |
items[].team_id | string<uuid> | yes | |
items[].name | string | yes | |
items[].avatar | BoardAvatar | null | yes | |
items[].avatar.file_id | string<uuid> | yes | |
items[].avatar.content_url | string | yes | |
items[].emoji | string | null | yes | |
items[].cover | BoardCover | null | yes | |
items[].cover.file_id | string<uuid> | null | yes | |
items[].cover.position | integer | yes | |
items[].cover.color | oneOf | yes | |
items[].cover.content_url | string | null | yes | /api/teams/{team_id}/files/{file_id}/content (same-origin) |
items[].timeline_id | string<uuid> | null | yes | |
items[].effective_view | string | yes | override do usuario no board > conta > default do board > kanban enum: |
items[].position | integer | yes | ordem do pin (1..N); nos recentes, sempre 0 |
items[].opened_at | string<date-time> | no | 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.
| 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 |
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/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())