Run Guardian checks on an email message

Run Guardian content validation on an email message and return errors and warnings before you publish or send.

GET /v1/email-messages/{emailMessageId}/guardian

Run Guardian checks on an email message

cURL

curl --request GET \
  --url https://app.loops.so/api/v1/email-messages/{emailMessageId}/guardian \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.loops.so/api/v1/email-messages/{emailMessageId}/guardian"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.loops.so/api/v1/email-messages/{emailMessageId}/guardian', 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://app.loops.so/api/v1/email-messages/{emailMessageId}/guardian",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.loops.so/api/v1/email-messages/{emailMessageId}/guardian"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.loops.so/api/v1/email-messages/{emailMessageId}/guardian")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.loops.so/api/v1/email-messages/{emailMessageId}/guardian")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "errors": [
    {
      "rule": "missingButtonHrefs",
      "title": "Missing button link",
      "description": "Buttons won't work without href value",
      "items": [
        {
          "label": "Click here"
        }
      ]
    },
    {
      "rule": "missingLinkHrefs",
      "title": "Missing text link",
      "description": "Links won't work without href value",
      "items": [
        {
          "label": "See more"
        }
      ]
    }
  ],
  "warnings": []
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Run the same Guardian checks that run in the Loops editor on a saved email message. Use this to validate campaign, workflow, and transactional email content before publishing or sending.

Checks depend on the email message’s parent type:

• Campaign validates contact properties and rendered links and buttons.
• Workflow validates contact properties, event properties from the workflow’s event trigger, and rendered links and buttons.
• Transactional validates data variables and rendered links and buttons.
• System transactional validates required data variables and rendered links and buttons.

This will not work on MJML email messages, as they are not supported in the API.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

emailMessageId · string · required

The ID of the email message.

Response

200

application/json

Successful.

errors · object[] · required

Validation errors. These must be resolved before the email can be published.

Show child attributes

warnings · object[] · required

Validation warnings. These are advisory and do not block publishing.

Show child attributes