Send a test reminder email

posthttps://api.expiryedge.com/v1/sendTestEmail

bearer token (Firebase ID token or session JWT); role editor or admin60/minJede Methode

Anfrage

curl -X POST 'https://api.expiryedge.com/v1/sendTestEmail' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "sam.lee@northwinddental.com",
  "expiryData": {
    "name": "State Dental License",
    "type": "License",
    "expiryDate": "2026-10-15",
    "priority": "High",
    "daysRemaining": 18
  }
}'

Antwort

{
  "message": "Test email sent successfully. 1 email credit has been deducted.",
  "details": {
    "recipient": "sam.lee@northwinddental.com",
    "expiry": "State Dental License",
    "daysLeft": 18
  }
}

Sends a sample reminder built from expiryData and deducts 1 email credit from the caller's organization (400 when none are left).

Body-Parameter

application/json

emailstringerforderlich
format: email
expiryDataobject
Sample expiry shown in the test message. Text is trimmed to a single short line; defaults are used for missing fields.

Rückgabe

200

Test email sent.

messagestring
detailsobject

Fehler

`400`	The request is missing required fields or contains invalid values.
`401`	Missing, expired or invalid bearer token.
`403`	Authenticated, but your role or organization does not allow this action.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.
`500`	Unexpected server error. Retry later; quote `requestId` to support.