> ## Documentation Index
> Fetch the complete documentation index at: https://loops.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Transactional email API examples
> Copy/paste code examples for sending transactional email with Loops via API and SDKs, including data variables, attachments, and error handling.
## Send a transactional email
[API reference](/api-reference/send-transactional-email)
```js JavaScript theme={"dark"}
await fetch("https://app.loops.so/api/v1/transactional", {
method: "POST",
headers: {
"Authorization": "Bearer ",
"Content-Type": "application/json"
},
body: JSON.stringify({
email: "test@example.com",
transactionalId: "",
dataVariables: {
loginUrl: "https://example.com/login",
},
}),
});
```
```js JavaScript SDK theme={"dark"}
import { LoopsClient } from "loops";
const loops = new LoopsClient("");
const response = await loops.sendTransactionalEmail({
email: "test@example.com",
transactionalId: "",
dataVariables: {
loginUrl: "https://example.com/login",
},
});
```
```php PHP SDK theme={"dark"}
use Loops\LoopsClient;
$loops = new LoopsClient("");
$result = $loops->transactional->send(
email: 'test@example.com',
transactional_id: '',
data_variables: [
'loginUrl' => 'https://example.com/login',
],
);
```
```ruby Ruby SDK theme={"dark"}
response = LoopsSdk::Transactional.send(
email: "test@example.com",
transactional_id: "",
data_variables: {
loginUrl: "https://example.com/login",
},
)
```
```python Python theme={"dark"}
import requests
response = requests.post(
"https://app.loops.so/api/v1/transactional",
headers={
"Authorization": "Bearer ",
"Content-Type": "application/json"
},
json={
"email": "test@example.com",
"transactionalId": "",
"dataVariables": {
"loginUrl": "https://example.com/login",
},
}
)
```
## Send a transactional email with an array data variable
Learn more about [arrays](/creating-emails/editor#arrays).
[API reference](/api-reference/send-transactional-email#param-data-variables)
```js JavaScript {11-14} theme={"dark"}
await fetch("https://app.loops.so/api/v1/transactional", {
method: "POST",
headers: {
"Authorization": "Bearer ",
"Content-Type": "application/json"
},
body: JSON.stringify({
email: "test@example.com",
transactionalId: "",
dataVariables: {
items: [
{ name: "Item 1", description: "Description of Item 1" },
{ name: "Item 2", description: "Description of Item 2" },
],
},
}),
});
```
```js JavaScript SDK {9-12} theme={"dark"}
import { LoopsClient } from "loops";
const loops = new LoopsClient("");
const response = await loops.sendTransactionalEmail({
email: "test@example.com",
transactionalId: "",
dataVariables: {
items: [
{ name: "Item 1", description: "Description of Item 1" },
{ name: "Item 2", description: "Description of Item 2" },
],
},
});
```
```php PHP SDK {9-18} theme={"dark"}
use Loops\LoopsClient;
$loops = new LoopsClient("");
$result = $loops->transactional->send(
email: 'test@example.com',
transactional_id: '',
data_variables: [
'items' => [
[
'name' => 'Item 1',
'description' => 'Description of Item 1',
],
[
'name' => 'Item 2',
'description' => 'Description of Item 2',
],
],
],
);
```
```ruby Ruby SDK {5-8} theme={"dark"}
response = LoopsSdk::Transactional.send(
email: "test@example.com",
transactional_id: "",
data_variables: {
items: [
{ name: "Item 1", description: "Description of Item 1" },
{ name: "Item 2", description: "Description of Item 2" },
],
},
)
```
```python Python {13-16} theme={"dark"}
import requests
response = requests.post(
"https://app.loops.so/api/v1/transactional",
headers={
"Authorization": "Bearer ",
"Content-Type": "application/json"
},
json={
"email": "test@example.com",
"transactionalId": "",
"dataVariables": {
"items": [
{ "name": "Item 1", "description": "Description of Item 1" },
{ "name": "Item 2", "description": "Description of Item 2" },
],
},
},
})
```
## Send a transactional email with attachments
You must request attachments to be enabled in your account before you can send emails with them.
[API reference](/api-reference/send-transactional-email#param-attachments)
```js JavaScript {13-19} theme={"dark"}
await fetch("https://app.loops.so/api/v1/transactional", {
method: "POST",
headers: {
"Authorization": "Bearer ",
"Content-Type": "application/json"
},
body: JSON.stringify({
email: "test@example.com",
transactionalId: "",
dataVariables: {
loginUrl: "https://example.com/login",
},
attachments: [
{
filename: "example.pdf",
contentType: "application/pdf",
data: "",
},
],
}),
});
```
```js JavaScript SDK {11-17} theme={"dark"}
import { LoopsClient } from "loops";
const loops = new LoopsClient("");
const response = await loops.sendTransactionalEmail({
email: "test@example.com",
transactionalId: "",
dataVariables: {
loginUrl: "https://example.com/login",
},
attachments: [
{
filename: "example.pdf",
contentType: "application/pdf",
data: "",
},
],
});
```
```php PHP SDK {11-17} theme={"dark"}
use Loops\LoopsClient;
$loops = new LoopsClient("");
$result = $loops->transactional->send(
email: 'test@example.com',
transactional_id: '',
data_variables: [
'loginUrl' => 'https://example.com/login',
],
attachments: [
[
'filename' => 'example.pdf',
'content_type' => 'application/pdf',
'data' => base64_encode(file_get_contents('path/to/example.pdf')),
],
],
);
```
```ruby Ruby SDK {7-13} theme={"dark"}
response = LoopsSdk::Transactional.send(
email: "test@example.com",
transactional_id: "",
data_variables: {
loginUrl: "https://example.com/login",
},
attachments: [
{
filename: 'example.pdf',
content_type: 'application/pdf',
data: '',
},
],
)
```
```python Python {15-21} theme={"dark"}
import requests
response = requests.post(
"https://app.loops.so/api/v1/transactional",
headers={
"Authorization": "Bearer ",
"Content-Type": "application/json"
},
json={
"email": "test@example.com",
"transactionalId": "",
"dataVariables": {
"loginUrl": "https://example.com/login",
},
"attachments": [
{
"filename": "example.pdf",
"contentType": "application/pdf",
"data": "",
},
],
}
)
```
## Send a transactional email with an idempotency key
Add an `Idempotency-Key` header to the request to prevent duplicate requests.
[API reference](/api-reference/send-transactional-email#param-idempotency-key)
```js JavaScript {6} theme={"dark"}
await fetch("https://app.loops.so/api/v1/transactional", {
method: "POST",
headers: {
"Authorization": "Bearer ",
"Content-Type": "application/json"
"Idempotency-Key": "550e8400-e29b-41d4-a716-446655440000",
},
body: JSON.stringify({
email: "test@example.com",
transactionalId: "",
dataVariables: {
loginUrl: "https://example.com/login",
},
}),
});
```
```js JavaScript SDK {11-13} theme={"dark"}
import { LoopsClient } from "loops";
const loops = new LoopsClient("");
const response = await loops.sendTransactionalEmail({
email: "test@example.com",
transactionalId: "",
dataVariables: {
loginUrl: "https://example.com/login",
},
headers: {
"Idempotency-Key": "550e8400-e29b-41d4-a716-446655440000",
},
});
```
```php PHP SDK {11-13} theme={"dark"}
use Loops\LoopsClient;
$loops = new LoopsClient("");
$result = $loops->transactional->send(
email: 'test@example.com',
transactional_id: '',
data_variables: [
'loginUrl' => 'https://example.com/login',
],
headers: [
'Idempotency-Key' => '550e8400-e29b-41d4-a716-446655440000',
],
);
```
```ruby Ruby SDK {7-9} theme={"dark"}
response = LoopsSdk::Transactional.send(
email: "test@example.com",
transactional_id: "",
data_variables: {
loginUrl: "https://example.com/login",
},
headers: {
'Idempotency-Key' => '550e8400-e29b-41d4-a716-446655440000',
},
)
```
```python Python {8} theme={"dark"}
import requests
response = requests.post(
"https://app.loops.so/api/v1/transactional",
headers={
"Authorization": "Bearer ",
"Content-Type": "application/json",
"Idempotency-Key": "550e8400-e29b-41d4-a716-446655440000",
},
json={
"email": "test@example.com",
"transactionalId": "",
"dataVariables": {
"loginUrl": "https://example.com/login",
},
}
)
```
## List published transactional emails
[API reference](/api-reference/list-transactional-emails)
```js JavaScript theme={"dark"}
await fetch("https://app.loops.so/api/v1/transactional", {
method: "GET",
headers: {
"Authorization": "Bearer ",
},
});
```
```js JavaScript SDK theme={"dark"}
import { LoopsClient } from "loops";
const loops = new LoopsClient("");
const response = await loops.getTransactionalEmails();
```
```php PHP SDK theme={"dark"}
use Loops\LoopsClient;
$loops = new LoopsClient("");
$result = $loops->transactional->get();
```
```ruby Ruby SDK theme={"dark"}
response = LoopsSdk::Transactional.list(perPage: 50)
```
```python Python theme={"dark"}
import requests
response = requests.get(
"https://app.loops.so/api/v1/transactional",
headers={
"Authorization": "Bearer ",
},
)
```