Criar Novo Grupo

Descrição

Cria um novo grupo dentro de uma organização específica. O nome do grupo deve ser único dentro da mesma organização.

Verbo

POST

URL Base

https://api.soargi.com

Endpoint

/groups

Cabeçalhos

Parâmetro Valor
Content-Type application/json
Authorization Bearer Token

Campos Esperados

Campo Tipo Obrigatório Descrição
org_id integer Sim ID da organização à qual o grupo será associado.
group_name string Sim Nome do grupo. Deve ser único dentro da organização.

Corpo da Requisição

{
    "group_name": "RH2 Team",
    "group_email": "email@group.com",
    "group_description": "lorem ipsum dolor sit amet, consectetur adipiscing elit..."
}

Sucesso - 201 (Grupo criado)

{
    "status": "success",
    "message": "Group created successfully.",
    "group_id": 51
}

Erro - 400 (Dados inválidos)

{
  "status": 400,
  "error": 400,
  "messages": {
    "group_name": "The group_name field is required."
  }
}

Erro - 400 (Dados inválidos)

{
    "status": 400,
    "error": 400,
    "messages": {
        "error": "Organization ID is required."
    }
}

Erro - 404 (Organização não encontrada)

{
    "status": 404,
    "error": 404,
    "messages": {
        "error": "The specified organization does not exist."
    }
}

Erro - 500 (Erro no Servidor)

{
  "status": 500,
  "error": "Failed to create group."
}

Códigos de Resposta

  • 201 - Grupo criado com sucesso
  • 400 - Dados inválidos ou grupo duplicado
  • 404 - Organização não encontrada
  • 500 - Falha inesperada ao criar grupo