Send a test email

View as Markdown

Sends a test email to the given address to verify email delivery is configured. Requires the notification:send permission.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Request

This endpoint expects an object.
tostringRequired
Recipient email address.

Response

The test email was sent.
sentboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error