Preview a template with real client data substituted for variables

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Template UUID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

clientId*string

UUID of the client to use for variable substitution

Response Body

`application/json`

curl -X POST "https://example.com/crm/templates/string/preview" \  -H "Content-Type: application/json" \  -d '{    "clientId": "string"  }'

{  "subject": "string",  "body": "string"}