Atualizar Grupo

Descrição

Atualiza as informações de um grupo existente com base no ID informado. É obrigatório informar o ID da organização à qual o grupo pertence e validar que o nome não esteja duplicado.

Verbo

PUT

URL Base

https://api.soargi.com

Endpoint

/groups/{id}

Cabeçalhos

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

Campos Permitidos

Campo Tipo Obrigatório Descrição
group_id integer Sim ID do grupo.
org_id integer Sim ID da organização associada ao grupo.
group_name string Sim Nome atualizado do grupo. Mínimo 3 caracteres.

Corpo da Requisição

{
    "group_id": 2,
    "org_id": 1,
    "group_name": "Financeiro"
}

Respostas

Sucesso - 200 (Grupo atualizado)

{
  "status": "success",
  "message": "Group updated successfully."
}

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

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

Erro - 422 (Erro de Validação)

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

Erro - 500 (Erro Interno do Servidor)

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

Códigos de Resposta

  • 200 - Grupo atualizado com sucesso
  • 404 - Grupo ou organização não encontrada
  • 422 - Dados inválidos ou grupo duplicado
  • 500 - Erro inesperado ao atualizar grupo