API reference · Email

Add a sending domain

Add your domain, publish the DNS records it returns, then verify with POST /v1/email/provision/domains/{id}/verify.

POST/v1/email/provision/domains

Bearer API key
Rate limit 120 / min
Returns 200 OK
Needs the Email permission · free

POST /v1/email/provision/domains

curl https://api.talks.africa/v1/email/provision/domains \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "dukafresh.co.ke"
  }'

{
  "id": "dom_1x9",
  "domain": "dukafresh.co.ke",
  "status": "pending",
  "spf_verified": false,
  "dkim_verified": false,
  "sending_ready": false,
  "dns_records": [
    {
      "type": "TXT",
      "name": "@",
      "purpose": "SPF"
    }
  ]
}

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

Body parameters

domainstringrequired
Your domain, e.g. dukafresh.co.ke.

Response fieldsResponse

status
pending or verified
spf_verified · dkim_verified · dmarc_verified
Check results
dns_records
Records to add at your DNS host
sending_ready
True once you can send

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?