GoliathDevelopersGet an API key
Reference/Communicationsgenerated from the gateway manifest

clearChannelSuppression

Lift an organization-wide opt-out.

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

Lift an organization-wide opt-out (suppressChannel's undo): the value can be texted, called or emailed again on that medium, on every contact carrying it. Only on the person's own word: an opt-out is the recipient's, and lifting it without their consent breaks the law the opt-out exists for. Idempotent; a value that is not suppressed is a no-op. Returns organizationId, normalizedValue, medium.

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": "clearChannelSuppression",
    "variables": {
      "value": "<String>",
      "medium": "SMS"
    }
  }'
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 = {
  value: '<String>',
  medium: 'SMS'
} as Parameters<typeof goliath.communications.clearChannelSuppression>[0]

const result = await goliath.communications.clearChannelSuppression(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: 'clearChannelSuppression',
    variables: {
      value: '<String>',
      medium: 'SMS'
    }
  }),
})
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.

valueString!required
mediumSuppressionMedium!required

The channel a value-level opt-out suppresses. SMS/VOICE take a phone value; EMAIL takes an email address.

SMSVOICEEMAIL

Response

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

response shape
{
  "data": {
    "contactMutation": {
      "clearSuppressionChannel": {
        "organizationId": "<ID>",
        "normalizedValue": "…",
        "medium": "SMS"
      }
    }
  }
}

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