GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

pauseContactsAi

pauseContactAi.

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

pauseContactAi (same mode and pausedUntil) for many contacts, as 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": "pauseContactsAi",
    "variables": {
      "contactIds": [
        "<String>"
      ],
      "mode": "ALL"
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

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

// Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type.
const variables = {
  contactIds: [
    '<String>'
  ],
  mode: 'ALL'
} as Parameters<typeof goliath.contacts.pauseContactsAi>[0]

const result = await goliath.contacts.pauseContactsAi(variables, { 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: 'pauseContactsAi',
    variables: {
      contactIds: [
        '<String>'
      ],
      mode: 'ALL'
    }
  }),
})
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.

contactIds[String!]!required
modeContactAiPauseMode!required

What an AI pause on a contact stops. ALL: Pause all AI: no AI employee runs on the contact; workflow AI employee steps are skipped. MESSAGES: Pause AI messages: runs continue, but no AI text, email or Slack message is suggested or sent. DRAFTS: AI off (the contact AI switch): runs and suggestions continue, but every AI text, email or contract waits for a person to approve it as a card, and AI calls are refused. No end time.

ALLMESSAGESDRAFTS
pausedUntilDateTime

Response

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

response shape
{
  "data": {
    "contactMutation": {
      "pauseContactsAi": {
        "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 →

READgetContactREADgetContactsPropertiesREADfindContactsByNoteREADsearchInteractionsREADcountContactsREADfindContacts