Render a check-in preview with a labelled sample order
Renders the exact publication without sending, enrolling a recipient, or requiring a verified test destination.
POST
Renders the exact publication without sending, enrolling a recipient, or requiring a verified test destination.
apiKeyheader
x-api-key<token>application/json- body
templateId*TemplateIdMatch
^tmpl_[0-9a-hjkmnp-tv-z]{16,24}$publicationId*TemplatePublicationIdMatch
^tpub_[0-9a-hjkmnp-tv-z]{16,24}$fixture?stringLength
1 <= length <= 100templateData?channel*"email"Value in
"email"RecipePreviewResponse
application/json- response
fixture*stringLength
1 <= length <= 100publicationId*TemplatePublicationIdMatch
^tpub_[0-9a-hjkmnp-tv-z]{16,24}$channel*"email"Value in
"email"content*import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.integrationCatalog.recipePreview({
"templateId": "example",
"publicationId": "example",
"channel": "email"
});Example Response
{
"fixture": "string",
"publicationId": "string",
"channel": "email",
"content": {
"subject": "string",
"preheader": "string",
"html": "string",
"text": "string"
}
}