Axuz Developers

POST /teams/{teamId}/user-groups/

Cria grupo (so owner/admin do team)

  • Acesso: Membro da equipe
  • 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`.

201 Group; 400/403/409 (group_name_taken)/422 (membro de fora do team).

createUserGroupHandler — POST /teams/{t}/user-groups (owner/admin).

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
namestringsim

unico por team sem diferenciar maiuscula

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)

iconstringnão

ate 16 bytes: UM emoji (um grafema) OU nome do catalogo do front [a-z0-9-]{1,16}; HTML/controle sao rejeitados (400 invalid icon)

member_idsarray<string<uuid>>não

todos precisam ser membros do team

{
  "name": "string",
  "color": "string",
  "icon": "string",
  "member_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Respostas

201

criado

NomeTipoObrigatórioDescrição
idstring<uuid>sim
team_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)

iconstring | nullsim
member_idsarray<string<uuid>>sim
created_bystring<uuid>sim
created_atstring<date-time>sim
updated_atstring<date-time>sim

400

invalido

401

sem sessao

403

nao-membro ou membro sem papel owner/admin

409

nome repetido (group_name_taken)

422

algum member_ids nao e membro do team (user is not a team member)

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 POST 'https://api-workspace.axuz.net/teams/TEAM_ID/user-groups/' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","icon":"string","member_ids":["00000000-0000-0000-0000-000000000000"]}'

Node.js

const res = await fetch("https://api-workspace.axuz.net/teams/TEAM_ID/user-groups/", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "color": "string",
    "icon": "string",
    "member_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(
    "POST",
    "https://api-workspace.axuz.net/teams/TEAM_ID/user-groups/",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "name": "string",
        "color": "string",
        "icon": "string",
        "member_ids": [
            "00000000-0000-0000-0000-000000000000",
        ],
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())