Update SMTP configuration

curl --request PUT \
  --url https://api.example.com/api/auth/smtp-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "host": "<string>",
  "username": "<string>",
  "password": "<string>",
  "senderEmail": "jsmith@example.com",
  "senderName": "<string>",
  "minIntervalSeconds": 60
}
'

import requests

url = "https://api.example.com/api/auth/smtp-config"

payload = {
    "enabled": True,
    "host": "<string>",
    "username": "<string>",
    "password": "<string>",
    "senderEmail": "jsmith@example.com",
    "senderName": "<string>",
    "minIntervalSeconds": 60
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    host: '<string>',
    username: '<string>',
    password: '<string>',
    senderEmail: 'jsmith@example.com',
    senderName: '<string>',
    minIntervalSeconds: 60
  })
};

fetch('https://api.example.com/api/auth/smtp-config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/auth/smtp-config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'host' => '<string>',
    'username' => '<string>',
    'password' => '<string>',
    'senderEmail' => 'jsmith@example.com',
    'senderName' => '<string>',
    'minIntervalSeconds' => 60
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/auth/smtp-config"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"host\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"senderEmail\": \"jsmith@example.com\",\n  \"senderName\": \"<string>\",\n  \"minIntervalSeconds\": 60\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/auth/smtp-config")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"host\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"senderEmail\": \"jsmith@example.com\",\n  \"senderName\": \"<string>\",\n  \"minIntervalSeconds\": 60\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/auth/smtp-config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"host\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"senderEmail\": \"jsmith@example.com\",\n  \"senderName\": \"<string>\",\n  \"minIntervalSeconds\": 60\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "host": "<string>",
  "port": 123,
  "username": "<string>",
  "hasPassword": true,
  "senderEmail": "jsmith@example.com",
  "senderName": "<string>",
  "minIntervalSeconds": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

PUT

api

auth

smtp-config

Update SMTP configuration

curl --request PUT \
  --url https://api.example.com/api/auth/smtp-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "host": "<string>",
  "username": "<string>",
  "password": "<string>",
  "senderEmail": "jsmith@example.com",
  "senderName": "<string>",
  "minIntervalSeconds": 60
}
'

import requests

url = "https://api.example.com/api/auth/smtp-config"

payload = {
    "enabled": True,
    "host": "<string>",
    "username": "<string>",
    "password": "<string>",
    "senderEmail": "jsmith@example.com",
    "senderName": "<string>",
    "minIntervalSeconds": 60
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    host: '<string>',
    username: '<string>',
    password: '<string>',
    senderEmail: 'jsmith@example.com',
    senderName: '<string>',
    minIntervalSeconds: 60
  })
};

fetch('https://api.example.com/api/auth/smtp-config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/auth/smtp-config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'host' => '<string>',
    'username' => '<string>',
    'password' => '<string>',
    'senderEmail' => 'jsmith@example.com',
    'senderName' => '<string>',
    'minIntervalSeconds' => 60
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/auth/smtp-config"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"host\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"senderEmail\": \"jsmith@example.com\",\n  \"senderName\": \"<string>\",\n  \"minIntervalSeconds\": 60\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/auth/smtp-config")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"host\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"senderEmail\": \"jsmith@example.com\",\n  \"senderName\": \"<string>\",\n  \"minIntervalSeconds\": 60\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/auth/smtp-config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"host\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"senderEmail\": \"jsmith@example.com\",\n  \"senderName\": \"<string>\",\n  \"minIntervalSeconds\": 60\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "host": "<string>",
  "port": 123,
  "username": "<string>",
  "hasPassword": true,
  "senderEmail": "jsmith@example.com",
  "senderName": "<string>",
  "minIntervalSeconds": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

enabled

boolean

required

When true, host/username/senderEmail/senderName become required

port

enum<integer>

required

Available options:

25,

465,

587,

2525

host

string

Required when enabled is true

username

string

Required when enabled is true

password

string

SMTP password (optional on update if unchanged)

senderEmail

string<email>

Required when enabled is true

senderName

string

Required when enabled is true

minIntervalSeconds

integer

default:60

Minimum interval between emails in seconds

Required range: x >= 0

Response

SMTP configuration updated

string<uuid>

enabled

boolean

host

string

port

integer

username

string

hasPassword

boolean

Whether a password is set (actual password is never exposed)

senderEmail

string<email>

senderName

string

minIntervalSeconds

integer

Required range: x >= 0

createdAt

string<date-time>

updatedAt

string<date-time>

⌘I

Tables

Schedules

Authentication

Records

Storage

Model Gateway

Functions

Realtime

Messaging

Payments

Secrets

Logs

Usage

Metadata

Health

Deployments

Dashboard

Update SMTP configuration

Authorizations

Body

Response