API Docs / Schemas / TestEmailRequest

TestEmailRequest

Request to send a test email for verifying configuration

Properties

Name Type Description
recipientEmailstring

Email address to send the test email to

Email address to send the test email to

recipientNamestring

Optional name of the recipient

Optional name of the recipient

subjectstring

Optional custom subject line. Defaults to "Test Email - Configuration Verification" if not provided.

Optional custom subject line. Defaults to "Test Email - Configuration Verification" if not provided.

htmlBodystring

Optional custom HTML body. Defaults to a standard verification message if not provided.

Optional custom HTML body. Defaults to a standard verification message if not provided.

plainTextBodystring

Optional custom plain text body. Defaults to a standard verification message if not provided.

Optional custom plain text body. Defaults to a standard verification message if not provided.

JSON Example

{
  "recipientEmail": "string",
  "recipientName": "string",
  "subject": "string",
  "htmlBody": "string",
  "plainTextBody": "string"
}

Used By Operations