SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Outreach

Create a contact book

Names must be unique in the workspace.

POSThttps://app.softsolz.uk/api/v1/services/outreach/contact-books

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

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

namestringrequired

Contact book name.

descriptionstring

What the book is for.

visibilitystring

Who can see the book (default tenant). A plain API key only sees tenant books.

sharedUserIdsarray of integers

Members to share with when visibility is shared.

sharedRoleIdsarray of integers

Roles to share with when visibility is shared.

Response

Response Body

bookobjectThe contact book.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/outreach/contact-books \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Event sign-ups",
  "description": "People who signed up at the spring fair."
}'

Credentials

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": {
    "book": {
      "id": "42",
      "tenant_id": "4c1a7e52-9b3d-4f86-a2e1-7d5c0b9f3e61",
      "name": "Event sign-ups",
      "description": "People who signed up at the spring fair.",
      "created_by": 4115,
      "created_at": "2026-09-01T09:00:00.000Z",
      "updated_at": "2026-09-01T09:00:00.000Z",
      "entry_count": 250,
      "phone_count": 240,
      "email_count": 180,
      "visibility": "tenant",
      "shared_users": [
        {
          "user_id": 4115,
          "name": "Jane Doe",
          "email": "jane@example.com"
        }
      ],
      "shared_roles": [
        {
          "role_id": 12,
          "role_name": "manager"
        }
      ]
    }
  }
}