Praecise Platform
Menu

Rivier/ Reference/ campaigns

Campaigns mail preview create

post/mail/templates/preview

Render a template (or inline content) with data exactly as a send would, and list the variables it asked for that the data did not carry. Sends and stores nothing.

Before you call

Credential
Authorization: Bearer $KEY
Scope
campaigns:read
Mcp
rivier_campaign_mail_preview
Graphql
Query.campaignsMailPreviewCreate
Sdk
mail.preview
Cli
mail preview

Request bodyapplication/json, required

  • templatestring
    A saved template (name or id) At most 120 characters.
  • versioninteger
    At least 1.
  • subjectstring
    At most 998 characters.
  • htmlstring
    At most 1000000 characters.
  • textstring
    At most 1000000 characters.
  • dataobject
    Defaults to the template's test data

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown