Nunciatura Provista

API Documentation V1

Atualizar Descrição do Grupo

Atualiza apenas a descrição de um grupo eclesiástico fixo

Este endpoint é do tipo: Protected

Descrição

Atualiza apenas a descrição de um grupo eclesiástico fixo com as seguintes funcionalidades:

  • Restrição: Apenas a descrição pode ser editada
  • Nome, cor e imagem são fixos e não podem ser alterados
  • Valida que a descrição seja fornecida e válida
  • Retorna os dados atualizados do grupo
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

PUT

URL BASE

http://api.provista.dev.nabrasil.org.br/v1

ENDPOINT

/groups/{id}

Parâmetros de Rota

Parâmetro Tipo Obrigatório Descrição
id uuid Sim ID único do grupo (UUID)

Corpo da Requisição

Campo Tipo Obrigatório Descrição
description string Sim Nova descrição do grupo (máx. 1000 caracteres)

Nota: Apenas o campo description pode ser editado. Os demais campos (name, color, img_url) são fixos e não podem ser alterados.

Exemplo de Requisição

{
  "description": "Bispo em saída/transferido - Questionários (Descrição atualizada)"
}

Cabeçalhos

Parâmetro Valor
Authorization Bearer <token>
Content-Type application/json
Accept application/json

Respostas

Sucesso - 200

{
  "success": true,
  "message": "Descrição do grupo atualizada com sucesso",
  "data": {
    "id": "a022d1ee-3003-4afe-8686-d7aeb5b051c9",
    "initials": "G1",
    "name": "Grupo 1",
    "description": "Bispo em saída/transferido (Descrição atualizada)",
    "color": "bg-primary",
    "users_count": 5,
    "answers_received": 12,
    "answers_expected": 15,
    "completion_label": "12/15",
    "completion_percent": 80,
    "status": "Em andamento",
    "recent_informers": [
      {"initials": "JB", "blacklisted": false, "avatar_color": "#26BF94"}
    ],
    "has_more_users": false,
    "plus_badge_color": "#845ADF",
    "process": {"id": "uuid-processo", "name": "Diocese de São Paulo", "protocol": "PROV-2025-001"}
  }
}

Erro - 404 (Grupo não encontrado)

{
  "success": false,
  "message": "Grupo não encontrado"
}

Condição: O ID fornecido não corresponde a nenhum grupo existente

Erro - 422 (Dados inválidos)

{
  "success": false,
  "message": "Os dados fornecidos são inválidos",
  "errors": {
    "description": ["A descrição é obrigatória."]
  }
}

Condição: Descrição não fornecida ou excede o limite de 1000 caracteres

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token não fornecido"
}

Condição: Token JWT inválido, expirado ou não fornecido

Códigos de Resposta

Código Descrição
200 Descrição do grupo atualizada com sucesso
401 Token inválido ou expirado
404 Grupo não encontrado
422 Dados de validação inválidos