Email

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/email-address-bans?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-address-bans

Create a ban for an email address in an account. Bans prevent inbound or outbound email to the address. More

Body application/json

emailEmailAddressrequired

A valid, normalized email address.

reasonstringrequired

banned_untilstring · date-time | null

Responses

200application/json

schemaobject

dataobjectrequired

idstringrequired

Unique identifier for an email address ban.

account_idstringrequired

Unique identifier for an account.

emailEmailAddressrequired

A valid, normalized email address.

reasonstringrequired

banned_untilstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-address-bans" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"email":"value","reason":"string","banned_until":"value"}'

const payload = {"email":"value","reason":"string","banned_until":"value"};
const url = "${BASE_URL}/api/accounts/acc123/email-address-bans";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"email":"value","reason":"string","banned_until":"value"};
const url = "${BASE_URL}/api/accounts/acc123/email-address-bans";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"email":"value","reason":"string","banned_until":"value"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-address-bans",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"email":"value","reason":"string","banned_until":"value"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-address-bans",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"email":"value","reason":"string","banned_until":"value"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-address-bans", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"email":"value","reason":"string","banned_until":"value"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-address-bans", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"email":"value","reason":"string","banned_until":"value"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-address-bans", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"email":"value","reason":"string","banned_until":"value"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-address-bans", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"email":"value","reason":"string","banned_until":"value"}
uri = URI("${BASE_URL}/api/accounts/acc123/email-address-bans")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"email":"value","reason":"string","banned_until":"value"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-address-bans", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-address-bans");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"email\":\"value\",\"reason\":\"string\",\"banned_until\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/accounts/{account_id}/email-address-bans/{email_address_ban_id}

Remove a ban on an email address, allowing emails to be sent to it again. More

Responses

204

Ban removed

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/accounts/acc123/email-address-bans/string" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/email-address-bans/string";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/email-address-bans/string";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/accounts/acc123/email-address-bans/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/accounts/acc123/email-address-bans/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/email-address-bans/string", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/accounts/acc123/email-address-bans/string", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/accounts/acc123/email-address-bans/string", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/accounts/acc123/email-address-bans/string", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/email-address-bans/string")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/accounts/acc123/email-address-bans/string", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/accounts/acc123/email-address-bans/string");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/email-message-events

List delivery events for email messages within an account. Tracks status changes like sent, delivered, bounced, or complained. More Email

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailMessageEventrequired

An event associated with an email message, such as delivery, bounce, open, or click tracking.

idstringrequired

Unique identifier for an email message event.

account_idstringrequired

Unique identifier for an account.

email_message_idstringrequired

Unique identifier for an email message.

event_typestringrequired

metaobject | nullrequired

occurred_atstringrequired

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/email-message-events?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-message-events/search

Search email message events using Lucene-style query syntax.

Supported fields:

event_type: - Filter by event type (delivered, opened, bounced, etc.)
email_message_id: - Filter by specific message ID
occurred_at: - Filter by time range using start..end

Time range examples:

occurred_at:2026-01-01..2026-01-31
occurred_at:2026-01-01T00:00:00Z..2026-01-31T23:59:59Z
occurred_at:..2026-01-31T23:59:59Z (open start)
occurred_at:2026-01-01T00:00:00Z.. (open end)

Operators:

AND - Both conditions must match
OR - Either condition must match
* - Wildcard (e.g., event_type:deliv*)

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (event_type:, email_message_id:, occurred_at:), wildcards (*), and boolean operators (AND, OR). Example: 'event_type:delivered AND occurred_at:2026-01-01..2026-01-31'

limitinteger

Maximum number of results to return (default: 20, max: 100)

offsetinteger

Number of results to skip for pagination

sort

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailMessageEventrequired

An event associated with an email message, such as delivery, bounce, open, or click tracking.

idstringrequired

Unique identifier for an email message event.

account_idstringrequired

Unique identifier for an account.

email_message_idstringrequired

Unique identifier for an email message.

event_typestringrequired

metaobject | nullrequired

occurred_atstringrequired

metaobjectrequired

querystringrequired

totalnumberrequired

limitnumberrequired

offsetnumberrequired

sortrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-message-events/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}'

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/accounts/acc123/email-message-events/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/accounts/acc123/email-message-events/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-message-events/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-message-events/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-message-events/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-message-events/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-message-events/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-message-events/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
uri = URI("${BASE_URL}/api/accounts/acc123/email-message-events/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-message-events/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-message-events/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123,\"sort\":\"created_at:desc,id:asc\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-message-events/search-delete

Delete email message events matching a Lucene-style query. Use dry_run=true to preview what would be deleted.

Supported fields:

event_type: - Filter by event type
email_message_id: - Filter by specific message ID
occurred_at: - Filter by time range using start..end

Time range examples:

occurred_at:2026-01-01..2026-01-31
occurred_at:..2026-01-31T23:59:59Z
occurred_at:2026-01-01T00:00:00Z..

Operators:

AND - Both conditions must match
OR - Either condition must match
* - Wildcard (e.g., event_type:deliv*)

Safety:

Use dry_run: true first to verify the query matches expected events
The limit parameter caps deletions (default 100)

Body application/json

querystringrequired

dry_runboolean

If true, returns count of events that would be deleted without actually deleting

limitinteger

Maximum number of events to delete (default: 100, max: 10000). Use with caution.

Responses

200application/json

schemaobject

dataobjectrequired

deleted_countnumberrequired

deleted_idsarrayrequired

itemstringrequired

Unique identifier for an email message event.

dry_runbooleanrequired

metaobjectrequired

querystringrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","dry_run":true,"limit":123}'

const payload = {"query":"string","dry_run":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"limit":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","dry_run":true,"limit":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","dry_run":true,"limit":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-message-events/search-delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","dry_run":true,"limit":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","dry_run":true,"limit":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","dry_run":true,"limit":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","dry_run":true,"limit":123}
uri = URI("${BASE_URL}/api/accounts/acc123/email-message-events/search-delete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","dry_run":true,"limit":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-message-events/search-delete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"dry_run\":true,\"limit\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/email-messages

List all email messages sent or received within an account. Returns message metadata, delivery status, and content previews. More Email

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailMessagerequired

An email message sent or received by the account. Tracks sender, recipients, content, and delivery timestamps.

idstringrequired

Unique identifier for an email message.

account_idstringrequired

Unique identifier for an account.

hostnamestringrequired

directionrequired

from_contactobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

reply_to_contactsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_contactsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_contactsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_contactsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

subjectstringrequired

body_textstringrequired

body_htmlstringrequired

received_atstring | nullrequired

sent_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/email-messages?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-messages

Create a new email message record for an account. This stores the message without sending it immediately. More Email

Body application/json

email_identity_idstringrequired

Unique identifier for an email identity.

reply_to_contactsarray

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

to_contactsarrayrequired

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

cc_contactsarrayrequired

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

bcc_contactsarrayrequired

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

subjectstringrequired

body_textstringrequired

body_htmlstringrequired

Responses

200application/json

schemaobject

dataEmailMessagerequired

An email message sent or received by the account. Tracks sender, recipients, content, and delivery timestamps.

idstringrequired

Unique identifier for an email message.

account_idstringrequired

Unique identifier for an account.

hostnamestringrequired

directionrequired

from_contactobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

reply_to_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

subjectstringrequired

body_textstringrequired

body_htmlstringrequired

received_atstring | nullrequired

sent_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-messages" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"}'

const payload = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"};
const url = "${BASE_URL}/api/accounts/acc123/email-messages";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"};
const url = "${BASE_URL}/api/accounts/acc123/email-messages";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-messages",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-messages",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-messages", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-messages", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-messages", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-messages", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/email-messages")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"email_identity_id":"emi456","reply_to_contacts":[{"email":"value","name":"string"}],"to_contacts":[{"email":"value","name":"string"}],"cc_contacts":[{"email":"value","name":"string"}],"bcc_contacts":[{"email":"value","name":"string"}],"subject":"string","body_text":"string","body_html":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-messages", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-messages");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"email_identity_id\":\"emi456\",\"reply_to_contacts\":[{\"email\":\"value\",\"name\":\"string\"}],\"to_contacts\":[{\"email\":\"value\",\"name\":\"string\"}],\"cc_contacts\":[{\"email\":\"value\",\"name\":\"string\"}],\"bcc_contacts\":[{\"email\":\"value\",\"name\":\"string\"}],\"subject\":\"string\",\"body_text\":\"string\",\"body_html\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-messages/search

Search email messages using Lucene-style query syntax.

Supported fields:

from: - Search sender email/name
to: - Search recipient email/name
subject: - Search subject line
body: - Search body text
hostname: - Filter by hostname
direction: - Filter by direction (in/out)

Operators:

AND - Both conditions must match
OR - Either condition must match
* - Wildcard (e.g., from:*@example.com)

Examples:

from:john@example.com
subject:invoice AND direction:in
to:*@acme.com OR to:*@corp.com

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (from:, to:, subject:, body:, hostname:, direction:), wildcards (*), and boolean operators (AND, OR). Example: 'from:john@* AND subject:invoice'

limitinteger

Maximum number of results to return (default: 20, max: 100)

offsetinteger

Number of results to skip for pagination

sort

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailMessagerequired

An email message sent or received by the account. Tracks sender, recipients, content, and delivery timestamps.

idstringrequired

Unique identifier for an email message.

account_idstringrequired

Unique identifier for an account.

hostnamestringrequired

directionrequired

from_contactobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

reply_to_contactsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_contactsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_contactsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_contactsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

subjectstringrequired

body_textstringrequired

body_htmlstringrequired

received_atstring | nullrequired

sent_atstring | nullrequired

metaobjectrequired

querystringrequired

totalnumberrequired

limitnumberrequired

offsetnumberrequired

sortrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-messages/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}'

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/accounts/acc123/email-messages/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/accounts/acc123/email-messages/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-messages/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-messages/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-messages/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-messages/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-messages/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-messages/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
uri = URI("${BASE_URL}/api/accounts/acc123/email-messages/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-messages/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-messages/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123,\"sort\":\"created_at:desc,id:asc\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-messages/search-delete

Delete email messages matching a Lucene-style query. Use dry_run=true to preview what would be deleted.

Supported fields:

from: - Search sender email/name
to: - Search recipient email/name
subject: - Search subject line
body: - Search body text
hostname: - Filter by hostname
direction: - Filter by direction (in/out)

Operators:

AND - Both conditions must match
OR - Either condition must match
* - Wildcard (e.g., from:*@example.com)

Safety:

Use dry_run: true first to verify the query matches expected messages
The limit parameter caps deletions (default 100)

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (from:, to:, subject:, body:, hostname:, direction:), wildcards (*), and boolean operators (AND, OR). Example: 'from:john@* AND subject:invoice'

dry_runboolean

If true, returns count of messages that would be deleted without actually deleting

limitinteger

Maximum number of messages to delete (default: 100, max: 10000). Use with caution.

Responses

200application/json

schemaobject

dataobjectrequired

deleted_countnumberrequired

deleted_idsarrayrequired

itemstringrequired

Unique identifier for an email message.

dry_runbooleanrequired

metaobjectrequired

querystringrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-messages/search-delete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","dry_run":true,"limit":123}'

const payload = {"query":"string","dry_run":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/email-messages/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/email-messages/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"limit":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-messages/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","dry_run":true,"limit":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-messages/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","dry_run":true,"limit":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-messages/search-delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","dry_run":true,"limit":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-messages/search-delete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","dry_run":true,"limit":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-messages/search-delete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","dry_run":true,"limit":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-messages/search-delete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","dry_run":true,"limit":123}
uri = URI("${BASE_URL}/api/accounts/acc123/email-messages/search-delete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","dry_run":true,"limit":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-messages/search-delete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-messages/search-delete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"dry_run\":true,\"limit\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-messages/send

Send an email via the configured mail infrastructure. The email is queued as a job and delivered asynchronously. More Email

Body application/json

email_identity_idstringrequired

Email identity to use for the sender address

toarrayrequired

Primary recipients

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

ccarray

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

bccarray

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

reply_toobject

emailEmailAddressrequired

A valid, normalized email address.

namestring

subjectstringrequired

Email subject line

body_textstringrequired

Plain text body

body_htmlstringrequired

HTML body

correlation_inbound_message_idstring

Link to inbound message this is replying to

Responses

200application/json

schemaobject

dataobjectrequired

job_idstringrequired

Unique identifier for a queued job.

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-messages/send" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"}'

const payload = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"};
const url = "${BASE_URL}/api/accounts/acc123/email-messages/send";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"};
const url = "${BASE_URL}/api/accounts/acc123/email-messages/send";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-messages/send",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-messages/send",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-messages/send", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-messages/send", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-messages/send", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-messages/send", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"}
uri = URI("${BASE_URL}/api/accounts/acc123/email-messages/send")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"email_identity_id":"emi456","to":[{"email":"value","name":"string"}],"cc":[{"email":"value","name":"string"}],"bcc":[{"email":"value","name":"string"}],"reply_to":{"email":"value","name":"string"},"subject":"string","body_text":"string","body_html":"string","correlation_inbound_message_id":"eml4567"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-messages/send", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-messages/send");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"email_identity_id\":\"emi456\",\"to\":[{\"email\":\"value\",\"name\":\"string\"}],\"cc\":[{\"email\":\"value\",\"name\":\"string\"}],\"bcc\":[{\"email\":\"value\",\"name\":\"string\"}],\"reply_to\":{\"email\":\"value\",\"name\":\"string\"},\"subject\":\"string\",\"body_text\":\"string\",\"body_html\":\"string\",\"correlation_inbound_message_id\":\"eml4567\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/email-templates

List all email templates within an account. Templates define reusable email content with variable placeholders for personalization. More Email

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailTemplaterequired

A reusable email template with placeholders for dynamic content. Used for transactional emails like welcome messages, password resets, and notifications.

idstringrequired

Unique identifier for an email template.

account_idstringrequired

Unique identifier for an account.

namestringrequired

event_typestringrequired

editorrequired

editor_statestringrequired

mjmlstringrequired

subject_templatestringrequired

body_text_templatestringrequired

body_html_templatestringrequired

archived_atstring | null

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-templates

Create a new email template for an account. Templates support {{variable}} placeholders for dynamic content substitution. More Email

Body application/json

namestringrequired

event_typestringrequired

editorrequired

editor_statestringrequired

mjmlstringrequired

subject_templatestringrequired

body_text_templatestringrequired

body_html_templatestringrequired

Responses

200application/json

schemaobject

dataEmailTemplaterequired

A reusable email template with placeholders for dynamic content. Used for transactional emails like welcome messages, password resets, and notifications.

idstringrequired

Unique identifier for an email template.

account_idstringrequired

Unique identifier for an account.

namestringrequired

event_typestringrequired

editorrequired

editor_statestringrequired

mjmlstringrequired

subject_templatestringrequired

body_text_templatestringrequired

body_html_templatestringrequired

archived_atstring | null

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-templates" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"}'

const payload = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"};
const url = "${BASE_URL}/api/accounts/acc123/email-templates";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"};
const url = "${BASE_URL}/api/accounts/acc123/email-templates";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-templates",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-templates",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-templates", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-templates", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-templates", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-templates", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"}
uri = URI("${BASE_URL}/api/accounts/acc123/email-templates")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"id":"emt123","account_id":"acc456","name":"welcome","event_type":"user_welcome","editor":"grapesjs_mjml","editor_state":"{}","mjml":"<mjml><mj-body></mj-body></mjml>","subject_template":"Welcome to {{company_name}}!","body_text_template":"Hi {{name}}, welcome to our service.","body_html_template":"<p>Hi {{name}}, welcome to our service.</p>"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-templates", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-templates");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"id\":\"emt123\",\"account_id\":\"acc456\",\"name\":\"welcome\",\"event_type\":\"user_welcome\",\"editor\":\"grapesjs_mjml\",\"editor_state\":\"{}\",\"mjml\":\"<mjml><mj-body></mj-body></mjml>\",\"subject_template\":\"Welcome to {{company_name}}!\",\"body_text_template\":\"Hi {{name}}, welcome to our service.\",\"body_html_template\":\"<p>Hi {{name}}, welcome to our service.</p>\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/email-templates/search

Search account email templates using Lucene syntax. More Email

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (id:, name:, event_type:, subject_template:, body_text_template:, body_html_template:), wildcards (*), and boolean operators (AND, OR).

limitinteger

offsetinteger

sort

Responses

200application/json

schemaobject

dataarrayrequired

itemEmailTemplaterequired

A reusable email template with placeholders for dynamic content. Used for transactional emails like welcome messages, password resets, and notifications.

idstringrequired

Unique identifier for an email template.

account_idstringrequired

Unique identifier for an account.

namestringrequired

event_typestringrequired

editorrequired

editor_statestringrequired

mjmlstringrequired

subject_templatestringrequired

body_text_templatestringrequired

body_html_templatestringrequired

archived_atstring | null

metaobjectrequired

querystringrequired

totalnumberrequired

limitnumberrequired

offsetnumberrequired

sortrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/email-templates/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}'

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/accounts/acc123/email-templates/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/accounts/acc123/email-templates/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-templates/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/email-templates/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/email-templates/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/email-templates/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/email-templates/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/email-templates/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
uri = URI("${BASE_URL}/api/accounts/acc123/email-templates/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/email-templates/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/email-templates/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123,\"sort\":\"created_at:desc,id:asc\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/application-email-templates/{application_email_template_id}

Delete an application email template mapping. More

Responses

204

Deleted

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/application-email-templates/aet123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/application-email-templates/aet123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/application-email-templates/aet123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/application-email-templates/aet123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/application-email-templates/aet123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/application-email-templates/aet123", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/application-email-templates/aet123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/application-email-templates/aet123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/application-email-templates/aet123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/application-email-templates/aet123")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/application-email-templates/aet123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/application-email-templates/aet123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/application-email-templates/{application_email_template_id}

Get an application email template mapping by ID. More

Responses

200application/json

schemaobject

dataApplicationEmailTemplaterequired

Maps an event type to an email template for a specific application. Multiple templates can be mapped to the same event type with different weights for A/B testing or gradual rollout.

idstringrequired

Unique identifier for an application email template mapping.

email_identity_idstringrequired

Unique identifier for an email identity.

application_idstringrequired

Unique identifier for an application.

event_typestringrequired

template_idstringrequired

Unique identifier for an email template.

weightnumberrequired

Weight for selection. 0 disables a variant.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/application-email-templates/aet123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/application-email-templates/aet123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/application-email-templates/aet123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/application-email-templates/aet123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/application-email-templates/aet123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/application-email-templates/aet123", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/application-email-templates/aet123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/application-email-templates/aet123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/application-email-templates/aet123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/application-email-templates/aet123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/application-email-templates/aet123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/application-email-templates/aet123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/application-email-templates/{application_email_template_id}

Update an application email template mapping. More

Body application/json

event_typestring | null

email_identity_idstring | null

Unique identifier for an email identity.

template_idstring | null

Unique identifier for an email template.

weightnumber | null

Weight for selection. 0 disables a variant.

Responses

200application/json

schemaobject

dataApplicationEmailTemplaterequired

Maps an event type to an email template for a specific application. Multiple templates can be mapped to the same event type with different weights for A/B testing or gradual rollout.

idstringrequired

Unique identifier for an application email template mapping.

email_identity_idstringrequired

Unique identifier for an email identity.

application_idstringrequired

Unique identifier for an application.

event_typestringrequired

template_idstringrequired

Unique identifier for an email template.

weightnumberrequired

Weight for selection. 0 disables a variant.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/application-email-templates/aet123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '"value"'

const payload = "value";
const url = "${BASE_URL}/api/application-email-templates/aet123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = "value";
const url = "${BASE_URL}/api/application-email-templates/aet123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = "value";
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/application-email-templates/aet123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = "value";
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/application-email-templates/aet123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = "value";
const { body } = await request("${BASE_URL}/api/application-email-templates/aet123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = "value"
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/application-email-templates/aet123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = "value"
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/application-email-templates/aet123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`"value"`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/application-email-templates/aet123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = "value"
uri = URI("${BASE_URL}/api/application-email-templates/aet123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = "value";
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/application-email-templates/aet123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/application-email-templates/aet123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("\"value\"", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/applications/{application_id}/email-templates

List email template mappings for an application. More

Responses

200application/json

schemaobject

dataarrayrequired

itemApplicationEmailTemplaterequired

Maps an event type to an email template for a specific application. Multiple templates can be mapped to the same event type with different weights for A/B testing or gradual rollout.

idstringrequired

Unique identifier for an application email template mapping.

email_identity_idstringrequired

Unique identifier for an email identity.

application_idstringrequired

Unique identifier for an application.

event_typestringrequired

template_idstringrequired

Unique identifier for an email template.

weightnumberrequired

Weight for selection. 0 disables a variant.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/applications/app123/email-templates?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/applications/{application_id}/email-templates

Map an email template to an event type for an application. More

Body application/json

event_typestringrequired

email_identity_idstringrequired

Unique identifier for an email identity.

template_idstringrequired

Unique identifier for an email template.

weightnumberrequired

Weight for selection. 0 disables a variant.

Responses

200application/json

schemaobject

dataApplicationEmailTemplaterequired

Maps an event type to an email template for a specific application. Multiple templates can be mapped to the same event type with different weights for A/B testing or gradual rollout.

idstringrequired

Unique identifier for an application email template mapping.

email_identity_idstringrequired

Unique identifier for an email identity.

application_idstringrequired

Unique identifier for an application.

event_typestringrequired

template_idstringrequired

Unique identifier for an email template.

weightnumberrequired

Weight for selection. 0 disables a variant.

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app123/email-templates" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100}'

const payload = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100};
const url = "${BASE_URL}/api/applications/app123/email-templates";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100};
const url = "${BASE_URL}/api/applications/app123/email-templates";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/email-templates",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/email-templates",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100};
const { body } = await request("${BASE_URL}/api/applications/app123/email-templates", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app123/email-templates", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app123/email-templates", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app123/email-templates", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100}
uri = URI("${BASE_URL}/api/applications/app123/email-templates")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"id":"aet123","application_id":"app456","event_type":"user_welcome","template_id":"emt789","weight":100};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app123/email-templates", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/applications/app123/email-templates");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"id\":\"aet123\",\"application_id\":\"app456\",\"event_type\":\"user_welcome\",\"template_id\":\"emt789\",\"weight\":100}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/applications/{application_id}/email-templates/search

Search application email template mappings using Lucene syntax. More

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (id:, event_type:, template_id:, email_identity_id:), wildcards (*), and boolean operators (AND, OR).

limitinteger

offsetinteger

sort

Responses

200application/json

schemaobject

dataarrayrequired

itemApplicationEmailTemplaterequired

Maps an event type to an email template for a specific application. Multiple templates can be mapped to the same event type with different weights for A/B testing or gradual rollout.

idstringrequired

Unique identifier for an application email template mapping.

email_identity_idstringrequired

Unique identifier for an email identity.

application_idstringrequired

Unique identifier for an application.

event_typestringrequired

template_idstringrequired

Unique identifier for an email template.

weightnumberrequired

Weight for selection. 0 disables a variant.

metaobjectrequired

querystringrequired

totalnumberrequired

limitnumberrequired

offsetnumberrequired

sortrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app123/email-templates/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}'

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/applications/app123/email-templates/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/applications/app123/email-templates/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/email-templates/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/email-templates/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const { body } = await request("${BASE_URL}/api/applications/app123/email-templates/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app123/email-templates/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app123/email-templates/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app123/email-templates/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
uri = URI("${BASE_URL}/api/applications/app123/email-templates/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app123/email-templates/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/applications/app123/email-templates/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123,\"sort\":\"created_at:desc,id:asc\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/applications/{application_id}/email-templates/send

Send an application event email using configured application template mappings, with fallback to defaults when no mapping is available. More

Body application/json

event_typerequired

Application email event type.

toobjectrequired

Target recipient for this send.

emailEmailAddressrequired

A valid, normalized email address.

namestring

variablesobjectrequired

Template variables for event rendering.

provider_event_idstring

Optional idempotency key for dedupe. Generated when omitted.

Responses

200application/json

schemaobject

dataobjectrequired

Variant

Option 1object

statusrequired

job_idstringrequired

Unique identifier for a queued job.

Option 2object

statusrequired

reasonrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app123/email-templates/send" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"}'

const payload = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"};
const url = "${BASE_URL}/api/applications/app123/email-templates/send";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"};
const url = "${BASE_URL}/api/applications/app123/email-templates/send";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/email-templates/send",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/email-templates/send",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"};
const { body } = await request("${BASE_URL}/api/applications/app123/email-templates/send", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app123/email-templates/send", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app123/email-templates/send", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app123/email-templates/send", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"}
uri = URI("${BASE_URL}/api/applications/app123/email-templates/send")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"event_type":"auth_welcome","to":{"email":"value","name":"string"},"variables":{},"provider_event_id":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app123/email-templates/send", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/applications/app123/email-templates/send");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"event_type\":\"auth_welcome\",\"to\":{\"email\":\"value\",\"name\":\"string\"},\"variables\":{},\"provider_event_id\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/email-messages/{email_message_id}

Get an email message by its email message ID. More

Responses

200application/json

schemaobject

dataEmailMessagerequired

An email message sent or received by the account. Tracks sender, recipients, content, and delivery timestamps.

idstringrequired

Unique identifier for an email message.

account_idstringrequired

Unique identifier for an account.

hostnamestringrequired

directionrequired

from_contactobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

reply_to_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

subjectstringrequired

body_textstringrequired

body_htmlstringrequired

received_atstring | nullrequired

sent_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/email-messages/eml123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/email-messages/eml123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/email-messages/eml123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/email-messages/eml123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/email-messages/eml123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/email-messages/eml123", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/email-messages/eml123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/email-messages/eml123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/email-messages/eml123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/email-messages/eml123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/email-messages/eml123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/email-messages/eml123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/email-messages/{email_message_id}

Update an unsent outbound email message using JSON Merge Patch (RFC 7396). More

Body application/json

reply_to_contactsarray | null

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

to_contactsarray | null

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

cc_contactsarray | null

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

bcc_contactsarray | null

itemobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

subjectstring | null

body_textstring | null

body_htmlstring | null

Responses

200application/json

schemaobject

dataEmailMessagerequired

An email message sent or received by the account. Tracks sender, recipients, content, and delivery timestamps.

idstringrequired

Unique identifier for an email message.

account_idstringrequired

Unique identifier for an account.

hostnamestringrequired

directionrequired

from_contactobjectrequired

emailEmailAddressrequired

A valid, normalized email address.

namestring

reply_to_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

to_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

cc_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

bcc_contactsarrayrequired

itemobjectrequired

Nested fields truncated. Expand to continue inline, or use the model link.

subjectstringrequired

body_textstringrequired

body_htmlstringrequired

received_atstring | nullrequired

sent_atstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

409application/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/email-messages/eml123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '"value"'

const payload = "value";
const url = "${BASE_URL}/api/email-messages/eml123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = "value";
const url = "${BASE_URL}/api/email-messages/eml123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = "value";
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/email-messages/eml123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = "value";
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/email-messages/eml123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = "value";
const { body } = await request("${BASE_URL}/api/email-messages/eml123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = "value"
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/email-messages/eml123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = "value"
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/email-messages/eml123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`"value"`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/email-messages/eml123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = "value"
uri = URI("${BASE_URL}/api/email-messages/eml123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = "value";
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/email-messages/eml123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/email-messages/eml123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("\"value\"", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/email-templates/{email_template_id}

Delete an email template. More

Responses

204

Deleted

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

409application/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/email-templates/string" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/email-templates/string";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/email-templates/string";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/email-templates/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/email-templates/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/email-templates/string", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/email-templates/string", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/email-templates/string", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/email-templates/string", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/email-templates/string")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/email-templates/string", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/email-templates/string");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/email-templates/{email_template_id}

Get an email template by its email template ID. More

Responses

200application/json

schemaobject

dataEmailTemplaterequired

A reusable email template with placeholders for dynamic content. Used for transactional emails like welcome messages, password resets, and notifications.

idstringrequired

Unique identifier for an email template.

account_idstringrequired

Unique identifier for an account.

namestringrequired

event_typestringrequired

editorrequired

editor_statestringrequired

mjmlstringrequired

subject_templatestringrequired

body_text_templatestringrequired

body_html_templatestringrequired

archived_atstring | null

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/email-templates/emt456" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/email-templates/emt456";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/email-templates/emt456";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/email-templates/emt456",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/email-templates/emt456",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/email-templates/emt456", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/email-templates/emt456", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/email-templates/emt456", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/email-templates/emt456", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/email-templates/emt456")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/email-templates/emt456", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/email-templates/emt456");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/email-templates/{email_template_id}

Update properties of an email template by its ID within an account via RFC7396. Used to edit an email template. More

Body application/json

namestring | null

event_typestring | null

editor

editor_statestring | null

mjmlstring | null

subject_templatestring | null

body_text_templatestring | null

body_html_templatestring | null

archived_atstring | null

Responses

200application/json

schemaobject

dataEmailTemplaterequired

A reusable email template with placeholders for dynamic content. Used for transactional emails like welcome messages, password resets, and notifications.

idstringrequired

Unique identifier for an email template.

account_idstringrequired

Unique identifier for an account.

namestringrequired

event_typestringrequired

editorrequired

editor_statestringrequired

mjmlstringrequired

subject_templatestringrequired

body_text_templatestringrequired

body_html_templatestringrequired

archived_atstring | null

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error