GoliathDevelopersGet an API key
Reference/Workflowsgenerated from the gateway manifest

enrollInWorkflow

Enroll MANY contacts in one CONTACT workflow's ACTIVE version.

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

Enroll MANY contacts in one CONTACT workflow's ACTIVE version: the app's bulk "Add to workflow" on the Contacts table. ASYNC bulk task: returns a bulkTaskId before anything runs; poll getBulkTask. TWO selection forms, never combined. EXPLICIT: contactIds. FILTER-BACKED: filterId (a saved contact filter from listContactFilters; a teammate's private one is refused) OR filterTree (inline, saveFilter's CONTACT DSL, parsed STRICTLY) with selectCount: N, the first N matches in the filter's default order; excludeIds drops contacts from that window. NO select-all: a filter without selectCount is refused, so size the window with countContacts first. CAP: 20,000 contacts per call (the app's bulk-action limit, charged on the ids or selectCount); split a bigger audience with excludeIds or narrower filters. The workflow must be CONTACT with an ACTIVE version (PROPERTY or DEAL is refused; one record at a time is triggerWorkflowRun). Each enrolled contact starts a run that can TEXT or EMAIL them under the workflow's send window, daily caps and the org's sending safety. State the workflow and contact count to the user and get a go-ahead BEFORE submitting.

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": "enrollInWorkflow",
    "variables": {
      "workflowGroupId": "<workflowGroupId>"
    }
  }'
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.workflows.enrollInWorkflow(
  {
    workflowGroupId: '<workflowGroupId>'
  },
  { 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: 'enrollInWorkflow',
    variables: {
      workflowGroupId: '<workflowGroupId>'
    }
  }),
})
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.

workflowGroupIdID!required
contactIds[String!]
filterIdID
filterTreeJSON
selectCountInt
excludeIds[String!]

Response

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

response shape
{
  "data": {
    "contactMutation": {
      "createBulkTriggerWorkflowTask": {
        "mode": "SYNC",
        "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 →

READlistWorkflowsREADgetWorkflowREADgetWorkflowVersionGraphREADlistWorkflowRunsREADgetContentTemplateREADlistContentTemplates