Set BYOS SMTP credentials

POST

/smtp-config

const url = 'https://mail.teamander.com/v1/smtp-config';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"provider":"ses","host":"email-smtp.us-east-1.amazonaws.com","port":587,"username":"AKIA...","password":"secret","from_email":"noreply@yourdomain.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://mail.teamander.com/v1/smtp-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "provider": "ses", "host": "email-smtp.us-east-1.amazonaws.com", "port": 587, "username": "AKIA...", "password": "secret", "from_email": "noreply@yourdomain.com" }'

Stores and verifies your own SMTP provider. The connection is tested before saving.

Authorizations

bearerAuth

Request Body

application/json

object

provider

required

string

Allowed values: ses mailgun sendgrid custom

host

required

string

>= 1 characters <= 255 characters

port

required

integer

>= 1 <= 65535

username

required

string

>= 1 characters <= 255 characters

password

required

string

>= 1 characters <= 512 characters

tls_required

boolean

default: true

from_email

string format: email

from_name

string

<= 128 characters

Example

{
  "provider": "ses",
  "host": "email-smtp.us-east-1.amazonaws.com",
  "port": 587,
  "username": "AKIA...",
  "password": "secret",
  "from_email": "noreply@yourdomain.com"
}

Responses

200

Saved and verified

application/json

object

success

required

boolean

provider

required

string

Example

{
  "success": true,
  "provider": "ses"
}

400

Invalid host or connection failed

application/json

object

error

required

string

message

string

Example

{
  "error": "smtp_connection_failed"
}

401

Missing or invalid API key

application/json

object

error

required

string

message

string

Example

{
  "error": "Invalid API key"
}