GoliathDevelopersGet an API key
Reference/Employeesgenerated from the gateway manifest

runEmployeesOnContacts

Put AI employees on contacts and wake each pairing once.

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

Put AI employees on contacts and wake each pairing once (runNow, default true), and/or on a schedule (cron, timezone, maxRuns; no denser than daily). message (max 2000 chars) is an internal instruction carried into every run; the contact never sees it. Employees must be switched on. Like attachEmployeeToContacts it puts back a contact someone took that employee off (unless they did so after this call), so leave those out first. A contact the employee already has a follow-up booked for (nextBookedFollowUpAt on getEmployeeCaseload) gets a second touch before that one: say how many of the batch have one, so the person can choose. A bulk task (bulkTaskId, getBulkTask). The person approves it on a card.

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": "runEmployeesOnContacts",
    "variables": {
      "employeeIds": [
        "<employeeIds>"
      ],
      "contactIds": [
        "<String>"
      ]
    }
  }'
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.employees.runEmployeesOnContacts(
  {
    employeeIds: [
      '<employeeIds>'
    ],
    contactIds: [
      '<String>'
    ]
  },
  { 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: 'runEmployeesOnContacts',
    variables: {
      employeeIds: [
        '<employeeIds>'
      ],
      contactIds: [
        '<String>'
      ]
    }
  }),
})
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.

employeeIds[ID!]!required
contactIds[String!]!required
messageString
runNowBoolean

Default true.

scheduleBulkAiEmployeeScheduleInput
cronExpressionString!required

Standard 5-field cron expression, interpreted in `timezone`.

timezoneString!required

IANA zone the expression is read in, e.g. America/New_York.

maxRunsInt!required

Fires allowed before the schedule retires itself. Required: a selection-wide open-ended cadence is not creatable here.

Response

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

response shape
{
  "data": {
    "contactMutation": {
      "createBulkTriggerAgentSessionTask": {
        "bulkTaskId": "…"
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

409idempotency_conflict

A 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 →

READlistEmployeesREADgetEmployeeREADgetEmployeeCaseloadREADlistEmployeeChannelOptionsREADlistEmployeeSuggestionsREADlistEmployeeRevisions