v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB

Auth

Send test email

Sends a test email using the configured email server settings to verify SMTP connectivity and credentials. The request body must include the SMTP server settings (host, port, username, password, sender_email, sender_name) and the recipient_email address.

post/projects/{project_id}/branches/{branch_id}/auth/send_test_email

Request body

hoststring required

portinteger required

usernamestring required

passwordstring required

sender_emailstring required

sender_namestring required

recipient_emailstring email required

The email address to send the test email to.

Response

Response with the result of the test email send

successboolean required

Whether the test email was sent successfully.

error_messagestring

The error message from the email server.