API reference · Email

Send an email

Send one email from your verified domain, with your own HTML or a saved template.

POST/v1/email/send

Bearer API key
Rate limit 120 / min
Returns 200 OK
Needs the Email permission · 0.2 credits per email

POST /v1/email/send

curl https://api.talks.africa/v1/email/send \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Your receipt",
    "template_id": "order_receipt",
    "template_vars": {
      "first_name": "Amina"
    }
  }'

{
  "id": "eml_3kd91a",
  "status": "queued",
  "to": "[email protected]",
  "credits_used": 0.2
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Body parameters

tostringrequired
Recipient email.
subjectstringrequired
Subject line.
fromstringoptional
Sender on your verified domain.
from_namestringoptional
Sender display name.
htmlstringoptional
Body. Use either or both.
textstringoptional
Body. Use either or both.
template_idstringoptional
Saved template instead of html.
template_varsobjectoptional
Values for template fields.
ccstring[]optional
Extra recipients.
bccstring[]optional
Extra recipients.
reply_tostringoptional
Where replies go.
scheduled_atstringoptional
ISO 8601 time to send later.

Response fieldsResponse

id
Email ID
status
queued, sent, delivered or failed
credits_used
Credits charged

Errors

Tap one to see its response above.

All errors use the standard error object. Select one to see its response.

Was this page helpful?