POST /teams/{teamId}/user-groups/
Cria grupo (so owner/admin do team)
- Access: Team member
- 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`.
201 Group; 400/403/409 (group_name_taken)/422 (membro de fora do team).
createUserGroupHandler — POST /teams/{t}/user-groups (owner/admin).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes |
Request body
application/json · Required
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | unico por team sem diferenciar maiuscula |
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) |
icon | string | no | ate 16 bytes: UM emoji (um grafema) OU nome do catalogo do front |
member_ids | array<string<uuid>> | no | todos precisam ser membros do team |
{
"name": "string",
"color": "string",
"icon": "string",
"member_ids": [
"00000000-0000-0000-0000-000000000000"
]
}Responses
201
criado
| Name | Type | Required | Description |
|---|---|---|---|
id | string<uuid> | yes | |
team_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) |
icon | string | null | yes | |
member_ids | array<string<uuid>> | yes | |
created_by | string<uuid> | yes | |
created_at | string<date-time> | yes | |
updated_at | string<date-time> | yes |
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.
| 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 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())