Validate In-App HTML

POST

api

in-app

html

validate

Validate In-App HTML

curl --request POST \
  --url https://api.sequenzy.com/api/v1/in-app/html/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "html": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/in-app/html/validate"

payload = { "html": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({html: '<string>'})
};

fetch('https://api.sequenzy.com/api/v1/in-app/html/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/in-app/html/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'html' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/in-app/html/validate"

	payload := strings.NewReader("{\n  \"html\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/in-app/html/validate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"html\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/in-app/html/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"html\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "valid": true,
  "bytes": 92,
  "maxBytes": 102400,
  "conversions": [
    { "from": "{{${first_name}}}", "to": "{{firstName}}", "count": 1 }
  ],
  "scriptHosts": [],
  "closesItself": true,
  "warnings": [
    {
      "code": "braze_converted",
      "message": "Converted Braze Liquid: {{${first_name}}} → {{firstName}}"
    }
  ],
  "errors": []
}

{
  "success": true,
  "valid": false,
  "bytes": 16,
  "maxBytes": 102400,
  "conversions": [],
  "scriptHosts": [],
  "closesItself": false,
  "warnings": [
    {
      "code": "no_close",
      "message": "This HTML never calls sequenzy.close() or brazeBridge.closeMessage(). Keep the close button on so people can dismiss it."
    }
  ],
  "errors": [
    "Replace Braze Liquid that has no Sequenzy equivalent: {{${country}}}"
  ]
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: sequences:read"
}

{
  "type": "validation",
  "on": "body",
  "property": "/html",
  "message": "Expected string"
}

Checks a document for a custom HTML in-app message without saving anything: its size against the 100 KB limit, the Braze Liquid personalization Sequenzy converts (for example {{${email_address}}} to {{email}}), the hosts it loads scripts from, whether it closes itself, and anything that would block saving. Run it on a Survicate or Braze custom HTML message before using it as an in_app step with format: "html". Requires the sequences:read scope.

Body

string

required

The document: HTML, CSS and JavaScript. Documents up to 400 KB are checked, so an oversized one gets a clear error instead of a rejected request.

curl "https://api.sequenzy.com/api/v1/in-app/html/validate" \
  --request POST \
  --header "Authorization: Bearer $SEQUENZY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "html": "<p>Hi {{${first_name}}}</p><button onclick=\"brazeBridge.closeMessage()\">Close</button>" }'

Response

boolean

True when the document can be saved on an in-app step.

number

Size in UTF-8 bytes after Braze Liquid is converted.

number

The size limit, 102,400 bytes.

array

Braze Liquid converted to Sequenzy merge tags: { from, to, count }.

array

Hosts the document loads scripts from. Websites with a Content Security Policy must allow them.

boolean

True when the document calls sequenzy.close() or brazeBridge.closeMessage(), so the step can turn its close button off.

array

{ code, message } items: no_close, external_scripts, braze_converted and unsupported_bridge_method. Warnings don’t block saving.

array

Problems that block saving, such as an empty or oversized document or Braze Liquid with no Sequenzy equivalent.

{
  "success": true,
  "valid": true,
  "bytes": 92,
  "maxBytes": 102400,
  "conversions": [
    { "from": "{{${first_name}}}", "to": "{{firstName}}", "count": 1 }
  ],
  "scriptHosts": [],
  "closesItself": true,
  "warnings": [
    {
      "code": "braze_converted",
      "message": "Converted Braze Liquid: {{${first_name}}} → {{firstName}}"
    }
  ],
  "errors": []
}

{
  "success": true,
  "valid": false,
  "bytes": 16,
  "maxBytes": 102400,
  "conversions": [],
  "scriptHosts": [],
  "closesItself": false,
  "warnings": [
    {
      "code": "no_close",
      "message": "This HTML never calls sequenzy.close() or brazeBridge.closeMessage(). Keep the close button on so people can dismiss it."
    }
  ],
  "errors": [
    "Replace Braze Liquid that has no Sequenzy equivalent: {{${country}}}"
  ]
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: sequences:read"
}

{
  "type": "validation",
  "on": "body",
  "property": "/html",
  "message": "Expected string"
}

Validate In-App HTML

curl --request POST \
  --url https://api.sequenzy.com/api/v1/in-app/html/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "html": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/in-app/html/validate"

payload = { "html": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({html: '<string>'})
};

fetch('https://api.sequenzy.com/api/v1/in-app/html/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/in-app/html/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'html' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/in-app/html/validate"

	payload := strings.NewReader("{\n  \"html\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/in-app/html/validate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"html\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/in-app/html/validate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"html\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "valid": true,
  "bytes": 92,
  "maxBytes": 102400,
  "conversions": [
    { "from": "{{${first_name}}}", "to": "{{firstName}}", "count": 1 }
  ],
  "scriptHosts": [],
  "closesItself": true,
  "warnings": [
    {
      "code": "braze_converted",
      "message": "Converted Braze Liquid: {{${first_name}}} → {{firstName}}"
    }
  ],
  "errors": []
}

{
  "success": true,
  "valid": false,
  "bytes": 16,
  "maxBytes": 102400,
  "conversions": [],
  "scriptHosts": [],
  "closesItself": false,
  "warnings": [
    {
      "code": "no_close",
      "message": "This HTML never calls sequenzy.close() or brazeBridge.closeMessage(). Keep the close button on so people can dismiss it."
    }
  ],
  "errors": [
    "Replace Braze Liquid that has no Sequenzy equivalent: {{${country}}}"
  ]
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: sequences:read"
}

{
  "type": "validation",
  "on": "body",
  "property": "/html",
  "message": "Expected string"
}

​Body

​Response

Body

Response