Skip to main content
POST
Add an SMTP relay

Authorizations

Authorization
string
header
default:ACCESS_TOKEN
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Example:

"Business relay"

smtp_host
string
required
Example:

"smtp.example.com"

smtp_port
integer
required
Example:

587

smtp_username
string
required
Example:

"hello@example.com"

smtp_password
string<password>
required
smtp_security
enum<string>
required
Available options:
none,
starttls,
ssl_tls
status
enum<string>
Available options:
active,
inactive
is_default
boolean

Response

201 - application/json

Relay added.

success
boolean
required
Example:

true

message
string
required
Example:

"Done"

data
any
required

Payload; shape depends on the endpoint.