createCallList
Build a call list from contact ids, dialed in the order given (duplicates collapse).
Build a call list from contact ids, dialed in the order given (duplicates collapse). Every contact must be one you can open, or the whole build is refused. Collect the ids with filterContacts, ANDing in the condition {id: "dnc", fieldId: "doNotContact", value: false} (an OR root goes under a new AND root beside it; leave it out only when the person asked to override do-not-contact), so the count on your yes card leaves them out; a result cut short hides some rows’ flags, so never say none are do-not-contact from one. 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": "createCallList",
"variables": {
"contactIds": [
"<contactIds>"
]
}
}'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.createCallList(
{
contactIds: [
'<contactIds>'
]
},
{ 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: 'createCallList',
variables: {
contactIds: [
'<contactIds>'
]
}
}),
})
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.
Default "USER".
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"callListsMutation": {
"createCallList": {
"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
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.
idempotency_conflictA request with this Idempotency-Key is still in flight.
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 →