renderContentTemplate

Render a content template against a contact: collapse [a|b] spintax and substitute merge fields: the CONTACT vocabulary updateWorkflowGraph lists ({{firstName}}, {{contactPropertyAddress}}, {{userFirstName}}, …), matched exactly and case-sensitively. Returns the rendered subject/body plus missingVariables: every token that did NOT render, whether it had no value for this contact or could not render at all because contactId was omitted (contact tokens then remain as literal {{...}} text AND are listed as missing). Inspect missingVariables (empty = fully rendered). Send with sendText / sendEmail (behind the organization’s send consent attestation). Pass spintaxSeed for a deterministic variant. Omitting contactId previews spintax and user tokens only: never send a no-contact render of a template with contact tokens.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "renderContentTemplate",
    "variables": {
      "templateId": "<templateId>"
    }
  }'

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.renderContentTemplate({
  templateId: '<templateId>'
})

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',
  },
  body: JSON.stringify({
    operationId: 'renderContentTemplate',
    variables: {
      templateId: '<templateId>'
    }
  }),
})
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.

templateIdID!required

contactIdID

spintaxSeedInt

Response

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

response shape

{
  "data": {
    "workflowAutomationsQuery": {
      "renderContentTemplate": {
        "subject": "…",
        "body": "…",
        "bodyFormat": "…",
        "missingVariables": [
          "…"
        ],
        "usedVariables": [
          "…"
        ]
      }
    }
  }
}

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.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "operationId": "renderContentTemplate", "variables": { "templateId": "<templateId>" } }'

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.renderContentTemplate({ templateId: '<templateId>' })

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', }, body: JSON.stringify({ operationId: 'renderContentTemplate', variables: { templateId: '<templateId>' } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Behaviour

Related