Email Providers

Test an email provider by sending a test email to the logged-in user

post/email-providers/{id}/test

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/email-providers/{id}/test
  • Auth: HTTP bearer

Path parameters

idinteger required

Provider ID

Request body

fromstring required

Sender email address (must be verified with the provider)

from_namestring nullable

Sender display name

Example request

{
  "from": "test@example.com",
  "from_name": "My App"
}

Response

Test email result

errorstring nullable

Error message if the test failed

provider_message_idstring nullable

Provider message ID if successful

sent_tostring required

The email address the test was sent to

successboolean required

Whether the test email was sent successfully

Example response

{
  "sent_to": "user@example.com"
}

Changes

No recorded changes to this operation across all 53 revisions of this API.