Web-view email HTML

Overview

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 and substitutes placeholders. For the request path, it also stamps delivered_at/clicked_at/opened_at (tracking side effect).

Prerequisites

No authentication — this endpoint is public.
The emailRequestUniqueCode of the record you are targeting.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/campaign/email/web-view/{emailRequestUniqueCode}

Authentication

No bearer token required.
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).

Path parameters

Parameter	Type	Required	Description
`emailRequestUniqueCode`	string	Required	Identifier for the record you are targeting.

Query parameters

Field	Type	Required	Description
`store_id`	integer	Optional	nullable, Must be an existing location. Only used on the numeric-`unique_code` (template-id) branch to apply that store's placeholders.

How it works

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.

Response

200 OK · `200`

{
  "data": {
    "status": "success",
    "data": {
      "html_content": "<html><body><h1>Thanks for visiting!</h1><p>We would love your feedback. <a href=\"https://example.com/review\">Leave a review</a></p></body></html>"
    }
  }
}

404 Not found · `404`

{
  "message": "Email template not found",
  "status": "error",
  "errors": []
}

Errors

Status	Meaning
`404`	Not found
`422`	Returned when `store_id` is present but does not exist
`500`	Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/email/web-view/<emailRequestUniqueCode>?store_id=123" \
  --header 'Accept: application/json'

Updated 10 days ago

Did this page help you?