Send an email

Send a one-off email to a recipient.

Authorization

AuthorizationRequiredBearer <token>

Use your API key (sk_live_* or sk_test_*) as the Bearer token.

In: header

Request Body

application/jsonRequired

toRequiredstring

Format: "email"

subjectRequiredstring

htmlContentstring

textContentstring

templateIdstring

Use a saved template instead of inline content.

templateVariablesobject

curl -X POST "https://platform.caramedical.com/api/v1/emails/send" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "user@example.com",
    "subject": "string",
    "htmlContent": "string",
    "textContent": "string",
    "templateId": "string",
    "templateVariables": {}
  }'

Email sent.

{
  "messageId": "string",
  "status": "string"
}

Authorization

Request Body

Response

TypeScript