GoliathDevelopersGet an API key
Reference/Call Listsgenerated from the gateway manifest

createCallListFromContactFilter

Build a call list from a saved CONTACT filter.

POST/api/v1/callWRITEidempotent · 24 hruns as the key's owner
View as Markdown

Build a call list from a saved CONTACT filter (filterId from listContactFilters): the contacts it matches for you right now, in the filter's order, up to 10,000. The list is a snapshot; it does not follow later changes to the filter. Before the yes, count it with countContacts on a new AND root holding the filter's own tree (the root getFilter returns) and {id: "dnc", fieldId: "doNotContact", value: false} (without that condition when the person asked to override do-not-contact), and say do-not-contact people are left off. Optional build rules, frozen onto the list: maxNumbersPerContact (default 3), includeRelatives (default false), overrideDnc and overrideLitigator (default false; turning either on dials people who asked not to be called or are a litigation risk, so ask the person first), reachedTagId (a contact tag applied to everyone the run reaches). visibilityScope is USER (only you, the default) or ORG (your whole team). Pass buildAttemptKey (any unique string) and resend it unchanged on a retry so a lost response never builds a second list. A list nobody in the org can dial from (no calling line) is refused. Contacts the list cannot call (no number, do-not-contact, litigator) are left off and counted in cannotCallCount; truncatedCount counts contacts past the 10,000 cap. Returns the new list with its dialPath.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "createCallListFromContactFilter",
    "variables": {
      "filterId": "<filterId>"
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.callLists.createCallListFromContactFilter(
  {
    filterId: '<filterId>'
  },
  { idempotencyKey: crypto.randomUUID() },
)
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'createCallListFromContactFilter',
    variables: {
      filterId: '<filterId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

filterIdID!required
nameString
visibilityScopeString

Default "USER".

maxNumbersPerContactInt
includeRelativesBoolean
overrideDncBoolean
overrideLitigatorBoolean
reachedTagIdID
buildAttemptKeyString

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "callListsMutation": {
      "createCallListFromContactFilter": {
        "callList": {
          "id": "<ID>",
          "name": "…",
          "status": "…",
          "visibilityScope": "…",
          "maxNumbersPerContact": 0,
          "includeRelatives": true,
          "overrideDnc": true,
          "overrideLitigator": true,
          "cursorPosition": 0,
          "startedAt": "2026-01-01T00:00:00.000Z",
          "endedAt": "2026-01-01T00:00:00.000Z",
          "dialPath": "…",
          "createdByUser": {
            "id": "<ID>",
            "firstName": "…",
            "lastName": "…"
          },
          "lockedByUser": {
            "id": "<ID>",
            "firstName": "…",
            "lastName": "…"
          },
          "reachedTag": {
            "id": "<ID>",
            "name": "…"
          },
          "counts": {
            "total": 0,
            "pending": 0,
            "completed": 0,
            "skipped": 0,
            "dials": 0,
            "byDisposition": [
              {
                "disposition": "…",
                "count": 0
              }
            ]
          }
        },
        "truncatedCount": 0,
        "cannotCallCount": 0
      }
    }
  }
}

Errors

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →