Sign in
latestOpenAPI 3.1.02026-08-1014497184.0 KB

8b99dca11019

smtp
channel/email

Save a SMTP integration

Updates or creates the SMTP integration for the project.

put/integrations/smtp

Request body

hoststring required

SMTP server hostname

passwordstring required

SMTP authentication password

portinteger required

SMTP server port

security'none' | 'ssl' | 'starttls'

SMTP security/encryption method

usernamestring required

SMTP authentication username

Example request

{
  "from": {
    "email": "notifications@example.com",
    "name": "Example Notifications"
  },
  "host": "smtp.gmail.com",
  "password": "your-app-password",
  "port": 587,
  "reply_to": {
    "email": "support@example.com",
    "name": "Example Support"
  },
  "security": "starttls",
  "username": "user@example.com"
}

Response

OK

hoststring required

SMTP server hostname

passwordstring required

SMTP authentication password

portinteger required

SMTP server port

security'none' | 'ssl' | 'starttls'

SMTP security/encryption method

usernamestring required

SMTP authentication username

Example response

{
  "from": {
    "email": "notifications@example.com",
    "name": "Example Notifications"
  },
  "host": "smtp.gmail.com",
  "password": "your-app-password",
  "port": 587,
  "reply_to": {
    "email": "support@example.com",
    "name": "Example Support"
  },
  "security": "starttls",
  "username": "user@example.com"
}