Get an email message

Retrieve an email message, including its compiled LMX content.

GET /v1/email-messages/{emailMessageId}

Get an email message

cURL

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

import requests

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

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}', 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}",
  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}"

	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}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "id": "<string>",
  "subject": "<string>",
  "previewText": "<string>",
  "fromName": "<string>",
  "fromEmail": "<string>",
  "replyToEmail": "<string>",
  "lmx": "<string>",
  "contentRevisionId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "campaignId": "<string>",
  "transactionalId": "<string>",
  "ccEmail": "<string>",
  "bccEmail": "<string>",
  "languageCode": "<string>",
  "contactPropertiesFallbacks": {},
  "eventPropertiesFallbacks": {},
  "dataVariablesFallbacks": {},
  "warnings": [
    {
      "rule": "<string>",
      "severity": "warning",
      "message": "<string>",
      "path": "<string>"
    }
  ]
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

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.

id · string · required

The ID of the email message.

subject · string · required

The email subject.

previewText · string · required

The email preview text.

fromName · string · required

The email sender name.

fromEmail · string · required

The email sender email address.

replyToEmail · string · required

The email reply-to address.

emailFormat · enum<string> · required

The rendering format of the email.

Available options: styled, plain

lmx · string · required

The email body serialized as LMX.

contentRevisionId · string | null · required

The current content revision. Pass this as expectedRevisionId on your next update.

updatedAt · string<date-time> · required

campaignId · string

The campaign this email message belongs to. Present only when the message belongs to a campaign (mutually exclusive with transactionalId).

transactionalId · string

The transactional email this email message belongs to. Present only when the message belongs to a transactional email (mutually exclusive with campaignId).

ccEmail · string

The email CC address. Only present when set.

bccEmail · string

The email BCC address. Only present when set.

languageCode · string

Only present when set.

contactPropertiesFallbacks · object

Fallback values for contact properties. Only present when set.

Show child attributes

eventPropertiesFallbacks · object

Fallback values for event properties. Only present when set.

Show child attributes

dataVariablesFallbacks · object

Fallback values for data variables. Only present when set.

Show child attributes

warnings · object[]

Non-fatal issues raised while compiling the submitted LMX. Only present on update responses when warnings were produced.

Show child attributes