Atualizar Provedor de Email

Altera o provedor de email ativo (SendGrid, MailerSend ou nenhum)

Este endpoint é do tipo: Admin Only

Descrição

Atualiza o provedor de email que será usado pelo sistema com as seguintes funcionalidades:

Permite escolher entre SendGrid, MailerSend ou nenhum (desabilitar)
Valores aceitos: "sendgrid", "mailersend" ou "" (vazio para desabilitar)
O endpoint aceita tanto a key (ex: "mail_provider") quanto o ID UUID da configuração
O cache é automaticamente limpo após a atualização
Alterações são aplicadas imediatamente sem reiniciar o servidor
Requer autenticação JWT válida e permissão de administrador

Detalhes do Endpoint

VERBO

PUT

URL BASE

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

ENDPOINT

/admin/configs/{key|id}

Cabeçalhos

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

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
{key\|id}	string	Sim	Key da configuração (ex: "mail_provider") ou ID UUID (ex: "a0639f43-d20c-4555-bdcd-eaf94216d6bf")

Exemplos de URL

PUT /v1/admin/configs/mail_provider

PUT /v1/admin/configs/a0639f43-d20c-4555-bdcd-eaf94216d6bf

Body da Requisição

Exemplo - Usar SendGrid

{
  "value": "sendgrid"
}

Exemplo - Usar MailerSend

{
  "value": "mailersend"
}

Exemplo - Desabilitar Envio de Emails

{
  "value": ""
}

Campo	Tipo	Obrigatório	Descrição
value	string	Sim	Provedor: "sendgrid", "mailersend" ou "" (vazio)
is_active	boolean	Não	Ativar ou desativar a configuração (padrão: true)

Respostas

Sucesso - 200

{
  "success": true,
  "message": "Configuração atualizada com sucesso",
  "data": {
    "id": "uuid",
    "key": "mail_provider",
    "value": "mailersend",
    "group": "mail",
    "is_active": true
  }
}

Erro - 422 (Validação)

{
  "success": false,
  "message": "Erro de validação",
  "errors": {
    "value": [
      "O valor deve ser uma string"
    ]
  }
}

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

{
  "success": false,
  "message": "Configuração não encontrada"
}

Códigos de Resposta

Código	Descrição
200	Configuração atualizada com sucesso
401	Token não fornecido ou inválido
403	Acesso negado (apenas administradores)
404	Configuração não encontrada
422	Erro de validação

Nunciatura Provista