decideCatchUpCard

Decide one HARVEST or BUNDLE card (family; the others are answered through their own operations) as the decision bar does, on the person's word: verb ACCEPT or DISMISS, shownIds every row the card showed (listCatchUpCards), suggestionIds the ticked ones (ACCEPT sets the unticked aside; DISMISS dismisses them), reason for a DISMISS. An ACCEPT runs each row's action (a record change, a merge, a skip trace that spends credits and is queued as bulkTaskId, or a send). Behind the send consent attestation and Pause everything. remainingIds are rows still on the 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": "decideCatchUpCard",
    "variables": {
      "cardId": "<cardId>",
      "verb": "ACCEPT",
      "shownIds": [
        "<shownIds>"
      ],
      "suggestionIds": [
        "<suggestionIds>"
      ]
    }
  }'

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 = {
  cardId: '<cardId>',
  verb: 'ACCEPT',
  shownIds: [
    '<shownIds>'
  ],
  suggestionIds: [
    '<suggestionIds>'
  ]
} as Parameters<typeof goliath.notifications.decideCatchUpCard>[0]

const result = await goliath.notifications.decideCatchUpCard(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: 'decideCatchUpCard',
    variables: {
      cardId: '<cardId>',
      verb: 'ACCEPT',
      shownIds: [
        '<shownIds>'
      ],
      suggestionIds: [
        '<suggestionIds>'
      ]
    }
  }),
})
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.

cardIdID!required

verbWorkThroughVerb!required

ACCEPTDISMISS

shownIds[ID!]!required

suggestionIds[ID!]!required

reasonContactSuggestionDismissReason

NOT_RELEVANTWRONG_TONEWRONG_FACTSALREADY_DONEOTHERNO_LONGER_DISTRESSEDWRONG_PROPERTYNOT_MY_LEADWRONG_PERSONESTATE_ALREADY_HANDLEDSTILL_OWNSKEPT_MINESHOULDNT_MESSAGE

Response

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

response shape

{
  "data": {
    "workThroughMutation": {
      "decideCard": {
        "applied": 0,
        "refused": 0,
        "setAside": 0,
        "queued": 0,
        "alreadyDecided": 0,
        "bulkTaskId": "<ID>",
        "retired": 0,
        "refusalMessage": "…",
        "remainingIds": [
          "<ID>"
        ],
        "cardGone": true
      }
    }
  }
}

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 →

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": "decideCatchUpCard", "variables": { "cardId": "<cardId>", "verb": "ACCEPT", "shownIds": [ "<shownIds>" ], "suggestionIds": [ "<suggestionIds>" ] } }'

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 = { cardId: '<cardId>', verb: 'ACCEPT', shownIds: [ '<shownIds>' ], suggestionIds: [ '<suggestionIds>' ] } as Parameters<typeof goliath.notifications.decideCatchUpCard>[0] const result = await goliath.notifications.decideCatchUpCard(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: 'decideCatchUpCard', variables: { cardId: '<cardId>', verb: 'ACCEPT', shownIds: [ '<shownIds>' ], suggestionIds: [ '<suggestionIds>' ] } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Idempotency

Related