Skip to main content
POST
/
sendTestEmail
Send test email
curl --request POST \
  --url https://api.docsautomator.co/sendTestEmail \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "automationId": "abc123",
  "recipient": "test@example.com"
}
'
{
  "success": true,
  "message": "Test email sent successfully to test@example.com",
  "rateLimit": {
    "remaining": 123,
    "resetAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key from your workspace settings. Pass as Authorization: Bearer <key> or X-API-Key: <key>. Find it at app.docsautomator.co/settings/workspace/api.

Body

application/json
automationId
string
required

The automation ID.

recipient
string<email>
required

Email address to send the test to.

Response

Test email sent

success
boolean
Example:

true

message
string
Example:

"Test email sent successfully to test@example.com"

rateLimit
object
Last modified on June 12, 2026