GoliathDevelopersGet an API key
Reference/Email Checksgenerated from the gateway manifest

checkContactEmail

Check one of a contact's email addresses now.

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

Check one of a contact's email addresses now (contactEmailId from getContact emails) and save the result on it, as the contact page's Check does. Returns the address with its emailCheck (result DELIVERABLE, RISKY, UNDELIVERABLE or UNKNOWN). skipReason set means the check did not run (NO_CREDITS, PROVIDER_ERROR, …), nothing was spent and any earlier result stays. An address not on that contact is NOT_FOUND. One email-verification credit per address checked, the same credits as the app (plan allowance first, then bought; checkBillingAction with action EMAIL_VERIFICATION says how many are left), so name the count and have the person agree before a large one. ADMIN: the key owner must currently be an org admin.

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": "checkContactEmail",
    "variables": {
      "contactId": "<contactId>",
      "contactEmailId": "<contactEmailId>"
    }
  }'
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.emailChecks.checkContactEmail(
  {
    contactId: '<contactId>',
    contactEmailId: '<contactEmailId>'
  },
  { 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: 'checkContactEmail',
    variables: {
      contactId: '<contactId>',
      contactEmailId: '<contactEmailId>'
    }
  }),
})
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.

contactIdID!required
contactEmailIdID!required

Response

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

response shape
{
  "data": {
    "emailCheckMutation": {
      "checkContactEmail": {
        "skipReason": "NO_CREDITS",
        "contactEmail": {
          "id": "<ID>",
          "email": "…",
          "emailCheck": {
            "result": "DELIVERABLE",
            "reason": "…",
            "checkedAt": "2026-01-01T00:00:00.000Z",
            "source": "PERSON",
            "checkedBy": "…"
          }
        }
      }
    }
  }
}

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 →

READgetContactEmailCheckSummaryADMINcheckContactEmails