Web-view email HTML

Get the rendered HTML of a campaign email for the browser "view in web" link. Resolves a campaign email request by unique_code (or, if unique_code is numeric, a template by id), picks the base or follow-up template, substitutes placeholders, and — for the request path — stamps delivered_at/clicked_at/opened_at (tracking side effect).

Path params

ParameterTypeRequiredNotes
emailRequestUniqueCodestringRequiredIdentifier for the record you are targeting.

Auth

  • Public — no bearer token (unauthenticated campaign group; item marked noauth). Reached from the "view in browser" link in the email.

Rate limit

  • 30 requests/min per IP (public).

Query

FieldTypeRequiredNotes
store_idintegerOptionalnullable, Must be an existing location. Only used on the numeric-unique_code (template-id) branch to apply that store's placeholders.

Behaviour

  • 200 { status: "success", data: { html_content } }.
  • 404 (notFoundResponse) "Email template not found" or "Store not found".
  • 422 when store_id is present but does not exist.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json