Send a test reminder SMS

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

bearer token (Firebase ID token or session JWT); role editor or admin60/minAny method

Request

curl -X POST 'https://api.expiryedge.com/v1/sendTestSMS' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phoneNumber": "+15551234567",
  "expiryData": {
    "name": "State Dental License",
    "expiryDate": "2026-10-15",
    "daysRemaining": 18
  }
}'

Response

{
  "message": "Test SMS sent successfully. 1 message credit has been deducted.",
  "details": {
    "recipient": "+15551234567",
    "expiry": "State Dental License",
    "daysLeft": 18,
    "sent": true
  }
}

Sends a sample reminder SMS and deducts SMS credits from the caller's organization. Use E.164 phone numbers.

Body parameters

application/json

phoneNumberstringrequired
E.164 number.
expiryDataobject
Sample expiry shown in the test message. Text is trimmed to a single short line; defaults are used for missing fields.

Returns

200

Test SMS sent.

messagestring
detailsobject

Errors

`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.