API reference · Contacts

Create contacts

Send one contact, or an array to create many at once. Mixed results return 207 with a list of failures.

POST/v1/contacts

Bearer API key
Rate limit 120 / min
Returns 207 Multi-Status
Needs the Contacts permission · free

POST /v1/contacts

curl https://api.talks.africa/v1/contacts \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "phone": "+254700000000",
      "first_name": "Alice"
    },
    {
      "phone": "0700",
      "first_name": "Bob"
    }
  ]'

{
  "total": 2,
  "created_count": 1,
  "failed_count": 1,
  "failed": [
    {
      "index": 1,
      "phone": "0700",
      "code": "invalid_phone_number",
      "message": "Use international format"
    }
  ]
}

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

Body parameters

phonestringrequired
International format.
emailstringoptional
Email address.
first_namestringoptional
Name.
last_namestringoptional
Name.
companystringoptional
Company.

Response fieldsResponse

created_count · failed_count
For arrays
failed[]
index, phone, code and message for each failure

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?