GoliathDevelopersGet an API key
Reference/Employeesgenerated from the gateway manifest

setEmployeeSchedule

Replace.

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

Replace (or add) the schedule of one employee on one contact (attachmentId from getContactEmployees). A fresh cadence: runs already spent do not count against it. A schedule is a 5-field cron (cronExpression) read in an IANA timezone, at most once a day, and maxRuns, how many runs before it stops (never open-ended; at most five years of runs). Each run can text, email or call the contact, so it needs their yes; a card's counts.

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": "setEmployeeSchedule",
    "variables": {
      "attachmentId": "<attachmentId>",
      "cronExpression": "<String>",
      "timezone": "<String>",
      "maxRuns": 10
    }
  }'
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.setEmployeeSchedule(
  {
    attachmentId: '<attachmentId>',
    cronExpression: '<String>',
    timezone: '<String>',
    maxRuns: 10
  },
  { 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: 'setEmployeeSchedule',
    variables: {
      attachmentId: '<attachmentId>',
      cronExpression: '<String>',
      timezone: '<String>',
      maxRuns: 10
    }
  }),
})
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.

attachmentIdID!required
cronExpressionString!required
timezoneString!required
maxRunsInt!required

Response

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

response shape
{
  "data": {
    "aiEmployeesMutation": {
      "setAiEmployeeSchedule": {
        "id": "<ID>",
        "agentId": "<ID>",
        "schedule": {
          "cronExpression": "…",
          "timezone": "…",
          "nextFireAt": "2026-01-01T00:00:00.000Z",
          "maxRuns": 0,
          "runCount": 0
        }
      }
    }
  }
}

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