GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

decideContactSuggestionsInBulk

Accept or dismiss many cards at once.

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

Accept or dismiss many cards at once (verb ACCEPT or DISMISS, suggestionIds at most 500): each runs as its own Accept or Dismiss would, so an ACCEPT can send a reply per card. An id the key owner may not act on is dropped from the plan, not reported. dismissReason for a DISMISS. rowDecisions answers one card's own question for an ACCEPT ({ suggestionId, decisions }). Returns planned, applied, refused, truncated (only the first planned ran: call again) and unresolvedIds. An ACCEPT whose answer spends credits is refused (the app's costed bulk accept). Behind the send consent attestation and Pause everything, a DISMISS too.

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": "decideContactSuggestionsInBulk",
    "variables": {
      "verb": "ACCEPT",
      "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 = {
  verb: 'ACCEPT',
  suggestionIds: [
    '<suggestionIds>'
  ]
} as Parameters<typeof goliath.contacts.decideContactSuggestionsInBulk>[0]

const result = await goliath.contacts.decideContactSuggestionsInBulk(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: 'decideContactSuggestionsInBulk',
    variables: {
      verb: 'ACCEPT',
      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.

verbSuggestionDecisionVerb!required
ACCEPTDISMISS
suggestionIds[ID!]!required
dismissReasonContactSuggestionDismissReason
NOT_RELEVANTWRONG_TONEWRONG_FACTSALREADY_DONEOTHERNO_LONGER_DISTRESSEDWRONG_PROPERTYNOT_MY_LEADWRONG_PERSONESTATE_ALREADY_HANDLEDSTILL_OWNSKEPT_MINESHOULDNT_MESSAGE
rowDecisions[ContactSuggestionRowDecisionsInput!]

One named row's answer to its own card's quiz, for a bulk ACCEPT over an ids selection.

suggestionIdID!required
decisionsJSON!required

The card's answer, as its action type's decision schema spells it: the same `JSON` the single-card `decideSuggestion(decisions:)` takes, and parsed the same way: through the type's own STRICT schema, so a key the type does not have is refused rather than dropped.

Response

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

response shape
{
  "data": {
    "contactSuggestionMutation": {
      "decideContactSuggestionsInBulk": {
        "planned": 0,
        "applied": 0,
        "refused": 0,
        "truncated": true,
        "unresolvedIds": [
          "<ID>"
        ]
      }
    }
  }
}

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