Enviar notificação via E-mail

POST 
/v1/notifications/email

Envia uma mensagem de e-mail para o endereço informado

Request

application/json

Body

mailobjectrequired
toobject
required
oneOf
MOD1
Endereço de e-mail do destinatário
string
MOD2
Endereço de e-mail do destinatário
Array [
string
]
from string
Endereço de e-mail do remetente. Caso não informado, irá obter das configurações de notificação
Example: [email protected]
subject string
Assunto da mensagem.
Example: Saudações!
text stringrequired
Mensagem a ser enviada
Example: Olá, mundo!

transport

object

Configurações de transporte. Caso não informado, irá obter das configurações de notificação

host string

Endereço do servidor SMTP

Example: smtp.exemplo.com

port integer

Porta do servidor SMTP. Padrão 465 (SMTPS)

Possible values: [25, 465, 587, 2525]

Example: 465

auth

object

type stringrequired

Tipo de autenticação a ser utilizada

Possible values: [basic]

options

object

anyOf

Basic

username stringrequired

Nome de usuário

Example: username

password stringrequired

Senha

Example: password

Responses

202

Retorna quando a mensagem foi aceita, sem confirmar o envio da notificação..

application/json

Schema

Schema

message stringrequired

Mensagem de retorno

messageId stringrequired

Identificador da mensagem

Example (from schema)

{
  "message": "string",
  "messageId": "string"
}

400

Retorna quando ocorre um erro no envio da mensagem.

application/json

Schema

Schema

type string
error
Possible values: [error]
Example: error
status int32
O status HTTP da resposta
Example: 400
code string
Um código de erro específico da Base39
Possible values: [created, accepted, no_content, redirect, not_modified, bad_request, unauthorized, forbidden, not_found, method_not_allowed, conflict, precondition_failed, too_many_requests, internal_server_error, unavailable, item_name_invalid, insufficient_scope]
Example: item_name_invalid
message string
Uma breve descrição do erro
Example: Method Not Allowed

context

object

Um objeto de formato livre que contém contexto adicional sobre o erro. Os campos possíveis são definidos por endpoint. message é apenas um exemplo.

message string

More details on the error.

Example: Something went wrong.
help string
Um URL com links para mais informações sobre o motivo da ocorrência desse erro.
Example: https://docs.paketa.com.br/development/first-steps/errors
request string
Um identificador exclusivo para esta resposta, que pode ser usado ao entrar em contato com o suporte da Base39.
Example: abcdef123456

Example (from schema)

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context": {
    "message": "Something went wrong."
  },
  "help": "https://docs.paketa.com.br/development/first-steps/errors",
  "request": "abcdef123456"
}

Loading...