Skip to main content
POST

Authorizations

Authorization
string
header
required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId
string<uuid>
required

Company identifier

policyId
string<uuid>
required

Policy identifier

Body

application/json
templateId
string<uuid>
required

The template version to render.

packetId
string<uuid>

A packet on this record. Without it, packet smart tags render empty.

Response

The rendered email

The email a send would produce: the template rendered against the record, and the packet when one is given.

to
string[]
required

The template's resolved To addresses. Send uses the to you pass, so pass these or your own.

cc
string[]
required

The template's resolved Cc addresses.

replyTo
string[]
required

The resolved Reply-To. Empty means replies go to the sending user.

subject
string
required
html
string
required
text
string
required
emptyTags
string[]
required

The smart tags that resolved to nothing on this record, by tag name.

emptyTagLabels
string[]
required

The same smart tags by display name, in the same order.

invalidAddresses
string[]
required

Pieces of a To, Cc or Reply-To smart tag's value that are not email addresses; they are left out of to, cc and replyTo.

invalidLinks
string[]
required

Button link smart tags whose value is not an http, https or mailto link; their buttons are left out of the body.