API reference · Email

Send bulk email

Send a campaign to a group, a list or a CSV, with open and click tracking.

POST/v1/email/send-bulk

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

POST /v1/email/send-bulk

curl https://api.talks.africa/v1/email/send-bulk \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign_name": "November newsletter",
    "group_id": "grp_all",
    "subject": "What is new at Duka Fresh",
    "template_id": "newsletter",
    "track_opens": true
  }'

{
  "campaign_id": "cmp_77ad",
  "status": "queued",
  "recipient_count": 8410,
  "estimated_credits": 1682
}

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

Body parameters

subjectstringrequired
Subject line.
group_idstringoptional
Who to send to.
recipientsstringoptional
Who to send to.
csv_upload_idstringoptional
Who to send to.
template_idstringoptional
Content.
htmlstringoptional
Content.
track_opensbooleanoptional
Turn on tracking.
track_clicksbooleanoptional
Turn on tracking.
scheduled_atstringoptional
Send later.

Response fieldsResponse

campaign_id
Campaign ID
recipient_count
Addresses it will reach
estimated_credits
Expected credits

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?