v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Update company SMTP

Com este endpoint você pode atualizar os dados de e-mail personalizados de uma conta. Após o envio, as configurações são aplicadas e todos os e-mails enviados para documentos relacionados a empresa utilizam as credenciais. Verifique se os dados estão corretos e teste assim que realizar as configurações, pois caso seu provedor não permita envios por SMTP ou alguma configurações esteja errada, os envios de solicitações podem ser interrompidos!. Atenção! Utilizar credenciais personalizadas pode fazer com que os registros de mensagens enviadas não funcione corretamente, para configurar o retorno dos dados entre em contato com o suporte!

post/api/companies/conf/email

Request body

mail_hoststring required

Host do seu provedor de e-mails.

mail_fromstring required

Qual endereço de e-mail está enviando a mensagem.

mail_usernamestring required

Usuário de e-mail para autenticação (Na maioria dos casos é o mesmo do mail_from).

mail_passwordstring required

Senha do e-mail.

mail_encryption'ssl' | 'tsl' required

Tipo de autenticação.

mail_portinteger required

Porta de saída do provedor, somente números.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Configurações de e-mail salva com sucesso!"
}