Send template test email

Queues a safe test email for account health checks.

POST/api/v1/templates/send-test

Auth: Bearer API key with mail_api scope

Required headers

Header	Required	Value	Description
Authorization	Yes	Bearer <token>	API key, server OTP key, or public OTP token depending on endpoint.
Content-Type	Yes	application/json	All POST requests expect JSON payloads.

Request body

Field	Type	Required	Description
to	string \| string[]	Yes	Test recipient(s).
priority	'URGENT' \| 'NORMAL'	No	Queue priority.
senderEmailId	string	No	Verified sender override.

Code examples (all supported languages)

Snippets use placeholder tokens. Replace them with real credentials from your dashboard.

curl -X POST "https://risumail.risu.in/api/v1/templates/send-test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":["ops@example.com"]}'

Response schema

Canonical schema inferred from the documented success payload. Copy this block when generating typed clients.

{
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "required": [
        "id",
        "status"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string"
        }
      }
    }
  }
}

Success response example

{
  "success": true,
  "data": {
    "id": "mail_01J...",
    "status": "QUEUED"
  }
}

Common error cases

Status	Code	When
400	INVALID_INPUT	Missing recipient.
403	SENDER_NOT_VERIFIED	senderEmailId is not usable.
429	RATE_LIMITED	Rate limit reached.

Implementation notes

This endpoint does not require a templateId; payload is intentionally minimal for smoke tests.

Back to API reference index Error handling playbook