GoliathDevelopersGet an API key
Reference/Communicationsgenerated from the gateway manifest

clearContactDoNotContact

Take one contact off Do Not Contact, as the contact page's toggle does, so texts, calls, emails and workflows reach them again.

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

Take one contact off Do Not Contact, as the contact page's toggle does, so texts, calls, emails and workflows reach them again. Only when the contact asked to be contacted again. A value-level opt-out on one of their numbers or addresses stays until clearChannelSuppression lifts it. Returns the contact's id and doNotContact.

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": "clearContactDoNotContact",
    "variables": {
      "contactId": "<contactId>"
    }
  }'
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.communications.clearContactDoNotContact(
  {
    contactId: '<contactId>'
  },
  { 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: 'clearContactDoNotContact',
    variables: {
      contactId: '<contactId>'
    }
  }),
})
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

Response

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

response shape
{
  "data": {
    "contactMutation": {
      "clearContactDoNotContact": {
        "id": "<ID>",
        "doNotContact": 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 →

READlistCommunicationChannelsREADgetSendingLimitsREADgetMeetingTranscriptREADlistMeetingSummariesREADrenderContentTemplateREADgetSendConsentAttestation