v1.0.0

OpenAPI 3.0.3

Raw HTML Compilation

Server

https://plugins.stripo.email

Stripo plugin host

Client Libraries

Shell Curl

Methods

Methods Operations

post/api/v1/cleaner/v1/compress

Compile raw HTML and CSS

Accepts raw email HTML and CSS directly and returns compiled, export-ready HTML.

Unlike the session-based compilation endpoint, this method does not require an active editor session or email ID — it processes whatever HTML and CSS you provide.

Suitable for legacy integrations and external workflows where email content is managed outside the Stripo editor. Performs the same compilation pipeline: inlines CSS styles, resolves synchronizable modules, applies display conditions, adds UTM parameters, and generates AMP HTML when AMP markup is detected.

Body·

required

application/json

Request body for compiling email template HTML. Only html is required by runtime validation.

html
Type: string
max length:
9000000
required

Source email template HTML to compile.
apiRequestData
Type: string

Plugin request data, encoded as a JSON string, passed to synchronizable module replacement. In the editor UI this is derived from plugin apiRequestData only when synchronizable modules are enabled. Pass it only if the HTML contains synchronizable modules that must be resolved.
css
Type: string

CSS to inline into the HTML. If absent or empty, HTML is returned without CSS inlining. Non-blank CSS is rejected only when both the raw CSS and the CSS after comment removal exceed 5,000,000 characters.
customUtms
Type:

Custom query parameters to add to links along with standard UTM parameters.

Properties: 2
mergeTags
Type: array of string

Merge tag placeholders to preserve while processing links and UTM parameters.
minimize
Type: boolean | null

When true, removes unnecessary whitespace and compresses the regular HTML output.
utmCampaign
Type: string

Value to add as the utm_campaign query parameter on links.
utmContent
Type: string

Value to add as the utm_content query parameter on links.
utmMedium
Type: string

Value to add as the utm_medium query parameter on links.
utmSource
Type: string

Value to add as the utm_source query parameter on links.
utmTerm
Type: string

Value to add as the utm_term query parameter on links.

Responses

200
Type:

HTML was compiled successfully.
html
Type: string
required

Compiled HTML.

ampErrors
Type: array of string

AMP validation errors. Empty array means AMP validation passed; absent when AMP HTML was not generated.

ampHtml
Type: string

Generated AMP HTML. Returned only when AMP markup is detected in source HTML.

conditions
Type:

Display conditions extracted from the source HTML.

Properties: 5
preheader
Type: string

Hidden email preheader extracted from the HTML.

subject
Type: string

Email subject extracted from the HTML title.

syncModules
Type: array of integerFormat: int64

Synchronizable module IDs.
application/json
400
Type:

Bad request, unsupported content type, missing body, missing html, or validation error.
code
Type: string

Application error code, when available.

date
Type: stringFormat: date-time

Error timestamp, when available.

detailedError
Type: string

Detailed error description, when available.

error

Structured internal error data, when available.

message
Type: string

Human-readable error message.

params

Additional error parameters.

traceId
Type: string

Trace identifier, when available.

propertyName
additionalPropertyType: anything
application/json
401
Type:

Missing, invalid, or expired plugin authentication token.
message
Type: string

Error message returned by the API gateway auth filter.
application/json
429
Type:

Rate limit reached.
error
Type: string

Rate limit error code.
application/json
500

Unexpected service error.

post/api/v1/cleaner/v1/compress

curl https://plugins.stripo.email/api/v1/cleaner/v1/compress \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'ES-PLUGIN-AUTH: YOUR_SECRET_TOKEN' \
  --data '{
  "html": "<!DOCTYPE html><html><head><title>Subject</title></head><body><p>Hello</p></body></html>",
  "css": "p { color: red; }",
  "minimize": true,
  "utmSource": "newsletter",
  "utmMedium": "email",
  "utmCampaign": "spring_sale"
}'

Show Schema

{
  "html": "<!DOCTYPE html><html><head></head><body><p style=\"color:red\">Hello</p></body></html>",
  "subject": "Subject"
}

HTML was compiled successfully.

Models

Request body for compiling email template HTML. Only html is required by runtime validation.

html
Type: string
max length:
9000000
required

Source email template HTML to compile.
apiRequestData
Type: string

Plugin request data, encoded as a JSON string, passed to synchronizable module replacement. In the editor UI this is derived from plugin apiRequestData only when synchronizable modules are enabled. Pass it only if the HTML contains synchronizable modules that must be resolved.
css
Type: string

CSS to inline into the HTML. If absent or empty, HTML is returned without CSS inlining. Non-blank CSS is rejected only when both the raw CSS and the CSS after comment removal exceed 5,000,000 characters.
customUtms
Type:

Custom query parameters to add to links along with standard UTM parameters.

Properties: 2
mergeTags
Type: array of string

Merge tag placeholders to preserve while processing links and UTM parameters.
minimize
Type: boolean | null

When true, removes unnecessary whitespace and compresses the regular HTML output.
utmCampaign
Type: string

Value to add as the utm_campaign query parameter on links.
utmContent
Type: string

Value to add as the utm_content query parameter on links.
utmMedium
Type: string

Value to add as the utm_medium query parameter on links.
utmSource
Type: string

Value to add as the utm_source query parameter on links.
utmTerm
Type: string

Value to add as the utm_term query parameter on links.

html
Type: string
required

Compiled HTML.
ampErrors
Type: array of string

AMP validation errors. Empty array means AMP validation passed; absent when AMP HTML was not generated.
ampHtml
Type: string

Generated AMP HTML. Returned only when AMP markup is detected in source HTML.
conditions
Type:

Display conditions extracted from the source HTML.

Properties: 5
preheader
Type: string

Hidden email preheader extracted from the HTML.
subject
Type: string

Email subject extracted from the HTML title.
syncModules
Type: array of integerFormat: int64

Synchronizable module IDs.

afterScript
Type: string

Script inserted after the conditional content.
beforeScript
Type: string

Script inserted before the conditional content.
description
Type: string

Condition description.
id
Type: string

Condition identifier.
name
Type: string

Condition name.

name
Type: string

Custom query parameter name.
value
Type: string

Custom query parameter value.

code
Type: string

Application error code, when available.
date
Type: stringFormat: date-time

Error timestamp, when available.
detailedError
Type: string

Detailed error description, when available.
error

Structured internal error data, when available.
message
Type: string

Human-readable error message.
params

Additional error parameters.
traceId
Type: string

Trace identifier, when available.
propertyName
additionalPropertyType: anything

message
Type: string

Error message returned by the API gateway auth filter.

error
Type: string

Rate limit error code.

Raw HTML Compilation

Methods

Compile raw HTML and CSS

Body·

Responses

Models

{} CompressRequest

{} CompressResponse

{} Condition

{} CustomUtm

{} APIError

{} ResponseText

{} RateLimitError

Raw HTML Compilation

Methods

Compile raw HTML and CSS

Body·CompressRequest

Responses

Models

{} CompressRequest

{} CompressResponse

{} Condition

{} CustomUtm

{} APIError

{} ResponseText

{} RateLimitError

Body·