Skip to content
Reference/Templates/Preview Template

Preview Template

POSThttps://public.leadpattern.com/template/:name/preview
Plan: templatesapplication/json60 req/min

Render a template's resolved display text and raw component payload with variable values substituted. Omit a variable to get a bracketed placeholder like [customer_name] instead.

  • Variables you omit are rendered as [variableName].

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Path Parameters

1 field
namestring
required
Template name.

Body Parameters

2 fields
headerobject
optional
Header variable values (varName → value).
bodyobject
optional
Body variable values (varName → value).

Responses

JSON Response
{
  "type": "success",
  "data": {
    "message": {
      "body": "Hi John, your order ORD-1234 has shipped!"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "John",
            "parameter_name": "customer_name"
          },
          {
            "type": "text",
            "text": "ORD-1234",
            "parameter_name": "order_id"
          }
        ]
      }
    ]
  }
}

Sample Request Body

{
  "body": {
    "customer_name": "John",
    "order_id": "ORD-1234"
  }
}