GoliathDevelopersGet an API key
Reference/Employeesgenerated from the gateway manifest

detachEmployeeFromContacts

Remove contacts from an AI employee's list.

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

Remove contacts from an AI employee's list (at most 200 ids per call), so it stops answering them, and drop its schedule on them; the history stays. changedCount is how many were removed. When interruptedContactId is set the batch stopped there (interruptedReason says why): the contacts before it are done, so send that one and the rest again. Confirm with the person first.

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": "detachEmployeeFromContacts",
    "variables": {
      "employeeId": "<employeeId>",
      "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.employees.detachEmployeeFromContacts(
  {
    employeeId: '<employeeId>',
    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: 'detachEmployeeFromContacts',
    variables: {
      employeeId: '<employeeId>',
      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.

employeeIdID!required
contactIds[ID!]!required

Response

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

response shape
{
  "data": {
    "aiEmployeesMutation": {
      "detachAiEmployeeFromContacts": {
        "requestedCount": 0,
        "changedCount": 0,
        "interruptedContactId": "<ID>",
        "interruptedReason": "…"
      }
    }
  }
}

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 →