Create or replace the SMTP configuration
curl --request PUT \
--url https://api.voucher-staging.allride.io/partner/v1/smtp-configuration \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"host": "smtp.example-transit.example.com",
"port": 587,
"security": "starttls",
"username": "voucher-mailer",
"fromEmail": "no-reply@example.com",
"fromName": "Example Transit Gutscheine"
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
host: 'smtp.example-transit.example.com',
port: 587,
security: 'starttls',
username: 'voucher-mailer',
fromEmail: 'no-reply@example.com',
fromName: 'Example Transit Gutscheine'
})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/smtp-configuration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/smtp-configuration"
payload = {
"host": "smtp.example-transit.example.com",
"port": 587,
"security": "starttls",
"username": "voucher-mailer",
"fromEmail": "no-reply@example.com",
"fromName": "Example Transit Gutscheine"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.put("https://api.voucher-staging.allride.io/partner/v1/smtp-configuration")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"host\": \"smtp.example-transit.example.com\",\n \"port\": 587,\n \"security\": \"starttls\",\n \"username\": \"voucher-mailer\",\n \"fromEmail\": \"no-reply@example.com\",\n \"fromName\": \"Example Transit Gutscheine\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/smtp-configuration"
payload := strings.NewReader("{\n \"host\": \"smtp.example-transit.example.com\",\n \"port\": 587,\n \"security\": \"starttls\",\n \"username\": \"voucher-mailer\",\n \"fromEmail\": \"no-reply@example.com\",\n \"fromName\": \"Example Transit Gutscheine\"\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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/smtp-configuration",
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([
'host' => 'smtp.example-transit.example.com',
'port' => 587,
'security' => 'starttls',
'username' => 'voucher-mailer',
'fromEmail' => 'no-reply@example.com',
'fromName' => 'Example Transit Gutscheine'
]),
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;
}{
"data": {
"id": 38017,
"resource": "smtp-configuration",
"host": "smtp.example-transit.example.com",
"port": 587,
"security": "starttls",
"username": "voucher-mailer",
"passwordSet": true,
"fromEmail": "no-reply@example.com",
"fromName": "Example Transit Gutscheine",
"replyTo": null,
"status": "unverified",
"lastVerifiedAt": null,
"verificationRequestedAt": null,
"verificationCompletedAt": null,
"consecutiveFailures": 0,
"lastError": null,
"createdAt": "2026-10-20T08:00:00Z",
"updatedAt": "2026-10-22T09:10:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/smtp-configuration",
"type": "application/json"
}
}
}
}Email (SMTP and templates)
Create or replace the SMTP configuration
Creates (201) or replaces (200) your SMTP configuration. Every save sets status to unverified; existing email-otp links keep sending with the new settings, but new email-otp links need a successful :verify. Hosts resolving to private or reserved addresses are refused. Idempotency-Key is ignored. See Email OTP links.
Required permissions: manage-consumer-email · API keys: allowed · Recent sign-in: required for dashboard users (15 minutes)
PUT
/
partner
/
v1
/
smtp-configuration
Create or replace the SMTP configuration
curl --request PUT \
--url https://api.voucher-staging.allride.io/partner/v1/smtp-configuration \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"host": "smtp.example-transit.example.com",
"port": 587,
"security": "starttls",
"username": "voucher-mailer",
"fromEmail": "no-reply@example.com",
"fromName": "Example Transit Gutscheine"
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
host: 'smtp.example-transit.example.com',
port: 587,
security: 'starttls',
username: 'voucher-mailer',
fromEmail: 'no-reply@example.com',
fromName: 'Example Transit Gutscheine'
})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/smtp-configuration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/smtp-configuration"
payload = {
"host": "smtp.example-transit.example.com",
"port": 587,
"security": "starttls",
"username": "voucher-mailer",
"fromEmail": "no-reply@example.com",
"fromName": "Example Transit Gutscheine"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.put("https://api.voucher-staging.allride.io/partner/v1/smtp-configuration")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"host\": \"smtp.example-transit.example.com\",\n \"port\": 587,\n \"security\": \"starttls\",\n \"username\": \"voucher-mailer\",\n \"fromEmail\": \"no-reply@example.com\",\n \"fromName\": \"Example Transit Gutscheine\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/smtp-configuration"
payload := strings.NewReader("{\n \"host\": \"smtp.example-transit.example.com\",\n \"port\": 587,\n \"security\": \"starttls\",\n \"username\": \"voucher-mailer\",\n \"fromEmail\": \"no-reply@example.com\",\n \"fromName\": \"Example Transit Gutscheine\"\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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/smtp-configuration",
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([
'host' => 'smtp.example-transit.example.com',
'port' => 587,
'security' => 'starttls',
'username' => 'voucher-mailer',
'fromEmail' => 'no-reply@example.com',
'fromName' => 'Example Transit Gutscheine'
]),
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;
}{
"data": {
"id": 38017,
"resource": "smtp-configuration",
"host": "smtp.example-transit.example.com",
"port": 587,
"security": "starttls",
"username": "voucher-mailer",
"passwordSet": true,
"fromEmail": "no-reply@example.com",
"fromName": "Example Transit Gutscheine",
"replyTo": null,
"status": "unverified",
"lastVerifiedAt": null,
"verificationRequestedAt": null,
"verificationCompletedAt": null,
"consecutiveFailures": 0,
"lastError": null,
"createdAt": "2026-10-20T08:00:00Z",
"updatedAt": "2026-10-22T09:10:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/smtp-configuration",
"type": "application/json"
}
}
}
}Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Body
application/json
The complete SMTP configuration.
Publicly resolvable SMTP host name.
Maximum string length:
253465, 587 or 2525.
Available options:
465, 587, 2525 implicit-tls for 465, starttls for 587 and 2525.
Available options:
implicit-tls, starttls 1-320 characters.
Required string length:
1 - 320Sender address.
Maximum string length:
2541-80 characters; checked against the content rules.
Required string length:
1 - 801-512 characters; write-only. Required on the first PUT; omit it later to keep the stored password.
Required string length:
1 - 512Reply-to address.
Maximum string length:
254Response
Replaced (201 Created with Location on the first save).
Single-object envelope around a SmtpConfiguration.
Your SMTP server for OTP emails. Emails leave from AllRide's egress addresses.
Show child attributes
Show child attributes