Skip to main content
POST
Verify SMTP and send a test email

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.

Headers

Idempotency-Key
string

Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

All optional.

emailTemplateId
integer<uint64> | null

Send this template (rendered with sample data, subject prefixed [TEST]) instead of the platform test message.

Required range: 0 <= x <= 18446744073709552000
locale
enum<string> | null

Locale of the test email.

Available options:
de,
en

Response

OK

Single-object envelope around a SmtpConfiguration.

data
object
required

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