Compiling Email Templates

This API call allows inlining CSS styles into HTML tags and provides the final HTML code of email templates that are ready to be sent to recipients.

Server

https://plugins.stripo.email

Stripo API server

Client Libraries

Shell Curl

Methods

Methods Operations

get/coediting/v1/email/compilation

Get compiled email

Get compiled inline CSS into HTML email templates.

Query Parameters

minimize
Type: boolean

If true then html code will be in a format of a single line without line breaks
inlineCss
Type: boolean

Allows you to select the type of code in the received compiled email. inlineCss: true - by default. This means that we will see CSS placed inside tags when we make a compiled form of HTML. inlineCss: false - editor will not inline the CSS in the tags, but rather write it at the head of the email.

Headers

ES-PLUGIN-AUTH
Type: string
required

Stripo plugin auth token in the format - Bearer ${AUTH_TOKEN}
ES-PLUGIN-UI-DATA
Type: string
required

JSON string with parameters to identify email (Same as metadata param in UI editor). For example: {"emailId": "id1"}

Responses

200
Type:

Compiled email
ampErrors
Type: array of string

List of AMP errors inside AMP HTML email template

ampHtml
Type: string

Compiled AMP version of HTML

conditions
Type:

List of AMP errors inside AMP HTML email template

Properties: 5
html
Type: string

Compiled HTML

syncModules
Type: array of integerFormat: int64

List of IDs of sync modules what was found in the HTML
application/json

get/coediting/v1/email/compilation

curl 'https://plugins.stripo.email/coediting/v1/email/compilation?minimize=false&inlineCss=false' \
  --header 'ES-PLUGIN-AUTH: ' \
  --header 'ES-PLUGIN-UI-DATA: '

Show Schema

{
  "html": "string",
  "ampHtml": "string",
  "ampErrors": [
    "string"
  ],
  "syncModules": [
    1
  ],
  "conditions": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "beforeScript": "string",
      "afterScript": "string"
    }
  ]
}

Compiled email

Models

ampErrors
Type: array of string

List of AMP errors inside AMP HTML email template
ampHtml
Type: string

Compiled AMP version of HTML
conditions
Type:

List of AMP errors inside AMP HTML email template

Properties: 5
html
Type: string

Compiled HTML
syncModules
Type: array of integerFormat: int64

List of IDs of sync modules what was found in the HTML

afterScript
Type: string

Content of afterScript section
beforeScript
Type: string

Content of beforeScript section
description
Type: string

Condition description
id
Type: string

Condition ID
name
Type: string

Condition name