Render the draft or a version with test data (nothing is sent)
POST
/api/v1/workspaces/{workspace}/transactional/templates/{template}/preview
package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/transactional/templates/password-reset/preview"
payload := strings.NewReader("{ \"data\": { \"additionalProperty\": \"example\" }, \"html\": \"example\", \"mjml\": \"example\", \"plainText\": \"example\", \"preheader\": \"example\", \"subject\": \"example\", \"testData\": \"example\", \"to\": { \"email\": \"[email protected]\", \"name\": \"Sam Rivera\" }, \"variables\": [ { \"default\": \"example\", \"description\": \"example\", \"name\": \"reset_url\", \"required\": true, \"sample\": \"example\", \"sensitive\": true, \"type\": \"text\" } ], \"version\": \"draft\" }")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>") req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/transactional/templates/password-reset/preview';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"data":{"additionalProperty":"example"},"html":"example","mjml":"example","plainText":"example","preheader":"example","subject":"example","testData":"example","to":{"email":"[email protected]","name":"Sam Rivera"},"variables":[{"default":"example","description":"example","name":"reset_url","required":true,"sample":"example","sensitive":true,"type":"text"}],"version":"draft"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/transactional/templates/password-reset/preview \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "data": { "additionalProperty": "example" }, "html": "example", "mjml": "example", "plainText": "example", "preheader": "example", "subject": "example", "testData": "example", "to": { "email": "[email protected]", "name": "Sam Rivera" }, "variables": [ { "default": "example", "description": "example", "name": "reset_url", "required": true, "sample": "example", "sensitive": true, "type": "text" } ], "version": "draft" }'Permission: transactional:view
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspace
required
Workspace slug
string
Workspace slug
template
required
The template’s ID, such as password-reset, or its UUID
string
The template’s ID, such as password-reset, or its UUID
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
data
Data to render with instead of a test data set
object
key
additional properties
html
string
mjml
string
plainText
string
preheader
string
subject
string
testData
The name of a test data set
string
to
object
email
required
string
name
string
variables
Array<object>
object
default
string
description
string
name
required
string
required
required
boolean
sample
string
sensitive
required
Never stored: logs and stored content show ••••••
boolean
type
required
string
version
Draft (default), live, or a version number
string
Responses
Section titled “Responses”OK
Media typeapplication/json
object
defaults
required
Array<string>
fromEmail
required
string
fromName
required
string
html
required
string
missing
required
Array<string>
ok
required
boolean
preheader
required
string
problem
string
replyTo
required
string
sizeBytes
required
integer format: int64
subject
required
string
text
required
string
version
required
string
Example generated
{ "defaults": [ "example" ], "fromEmail": "example", "fromName": "example", "html": "example", "missing": [ "example" ], "ok": true, "preheader": "example", "problem": "example", "replyTo": "example", "sizeBytes": 1, "subject": "example", "text": "example", "version": "example"}default
Section titled “default”Error
Media typeapplication/problem+json
object
code
Stable error code, e.g. permission_denied
string
detail
A human-readable explanation specific to this occurrence of the problem.
string
errors
Optional list of individual error details
Array<object>
object
location
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
string
message
Error message text
string
value
The value at the given location
helpers
Members who hold the missing permission
Array<string>
instance
A URI reference that identifies the specific occurrence of the problem.
string format: uri
meta
object
key
additional properties
permission
The missing permission key
string
status
HTTP status code
integer format: int64
title
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
string
type
A URI reference to human-readable documentation for the error.
string format: uri
Example
{ "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}