Axuz Developers

PATCH /teams/{teamId}/boards/{id}/statuses/{sid}

Edita status

  • Acesso: Membro com escopo
  • 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`.

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.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
idpathstringsim
sidpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
namestringnão
colorstringnão

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)

categorystringnão

enum: "todo", "doing", "done", "cancelled"

linked_column_idstring<uuid> | nullnão
is_defaultbooleannão
{
  "name": "string",
  "color": "string",
  "category": "todo",
  "linked_column_id": "00000000-0000-0000-0000-000000000000",
  "is_default": true
}

Respostas

200

atualizado

NomeTipoObrigatórioDescrição
idstring<uuid>sim
team_idstring<uuid>sim
board_idstring<uuid>sim
namestringsim
colorstringsim

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)

categorystringsim

enum: "todo", "doing", "done", "cancelled"

positionintegersim
linked_column_idstring<uuid> | nullsim
is_defaultbooleansim
created_atstring<date-time>sim
updated_atstring<date-time>sim

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.

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 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())