Skip to main content
PUT
Create or replace the SMTP configuration

Authorizations

Authorization
string
header
required

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.

host
string
required

Publicly resolvable SMTP host name.

Maximum string length: 253
port
enum<integer>
required

465, 587 or 2525.

Available options:
465,
587,
2525
security
enum<string>
required

implicit-tls for 465, starttls for 587 and 2525.

Available options:
implicit-tls,
starttls
username
string
required

1-320 characters.

Required string length: 1 - 320
fromEmail
string<email>
required

Sender address.

Maximum string length: 254
fromName
string
required

1-80 characters; checked against the content rules.

Required string length: 1 - 80
password
string
write-only

1-512 characters; write-only. Required on the first PUT; omit it later to keep the stored password.

Required string length: 1 - 512
replyTo
string<email> | null

Reply-to address.

Maximum string length: 254

Response

Replaced (201 Created with Location on the first save).

Single-object envelope around a SmtpConfiguration.

data
object
required

Your SMTP server for OTP emails. Emails leave from AllRide's egress addresses.