Add people to a contact book

Each person needs a phone number with its country code, an email address, or both. People already in the book are counted as duplicates; anyone that cannot be added is listed in rejected.

POSThttps://app.softsolz.uk/api/v1/services/outreach/contact-books/{id}/entries

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

peoplearray of objectsrequired

People to add, at least one.

Response

Response Body

addedintegerPeople added to the book.

duplicatesintegerPeople already in the book, so not added again.

rejectedarray of objectsPeople that could not be added, and why.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/outreach/contact-books/{id}/entries \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "people": [
    {
      "phone": "+447700900123",
      "email": "jane@example.com",
      "display_name": "Jane Doe"
    },
    {
      "email": "sam@example.com",
      "display_name": "Sam Lee"
    }
  ]
}'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
  "data": {
    "added": 2,
    "duplicates": 0,
    "rejected": [
      {
        "phone": "07700900123",
        "email": "jane@",
        "reason": "needs_country_code"
      }
    ]
  }
}