PATCH /teams/{teamId}/boards/{id}/statuses/{sid}
Edita status
- Access: Member with scope
- 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`.
Ao menos um campo. linked_column_id: null desfaz o vinculo. is_default: true promove (o default anterior da categoria deixa de ser, na mesma transacao); false e 400. Mudar category de um status default e 409 (default_status_category); mudar a categoria de um status em uso recalcula o status texto das tarefas.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes | |
id | path | string | yes | |
sid | path | string | yes |
Request body
application/json · Required
| Name | Type | Required | Description |
|---|---|---|---|
name | string | no | |
color | string | no | token da paleta fechada (slate gray red orange amber yellow lime green teal cyan blue indigo violet purple pink rose) ou hex #RRGGBB (normalizado para minusculas) |
category | string | no | enum: |
linked_column_id | string<uuid> | null | no | |
is_default | boolean | no |
{
"name": "string",
"color": "string",
"category": "todo",
"linked_column_id": "00000000-0000-0000-0000-000000000000",
"is_default": true
}Responses
200
atualizado
| Name | Type | Required | Description |
|---|---|---|---|
id | string<uuid> | yes | |
team_id | string<uuid> | yes | |
board_id | string<uuid> | yes | |
name | string | yes | |
color | string | yes | token da paleta fechada (slate gray red orange amber yellow lime green teal cyan blue indigo violet purple pink rose) ou hex #RRGGBB (normalizado para minusculas) |
category | string | yes | enum: |
position | integer | yes | |
linked_column_id | string<uuid> | null | yes | |
is_default | boolean | yes | |
created_at | string<date-time> | yes | |
updated_at | string<date-time> | yes |
400
corpo vazio ou invalido
401
sem sessao
403
sem permissao de gerenciar o board
404
board ou status inexistente/de outro board
409
nome repetido, coluna ja vinculada ou categoria de default
422
coluna de outro board ou coluna is_done com status que nao e done
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 PATCH 'https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/statuses/SID' \
-H "Authorization: Bearer $AXUZ_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","color":"string","category":"todo","linked_column_id":"00000000-0000-0000-0000-000000000000","is_default":true}'Node.js
const res = await fetch("https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/statuses/SID", {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"color": "string",
"category": "todo",
"linked_column_id": "00000000-0000-0000-0000-000000000000",
"is_default": true
}),
});
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(
"PATCH",
"https://api-workspace.axuz.net/teams/TEAM_ID/boards/ID/statuses/SID",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
json={
"name": "string",
"color": "string",
"category": "todo",
"linked_column_id": "00000000-0000-0000-0000-000000000000",
"is_default": True,
},
timeout=30,
)
res.raise_for_status()
print(res.json())