Create an email template

Requires EDITOR. variables are {{var}} placeholder names. attachments are email_assets ids (≤3, combined ≤7MB). Response may include aliyunDegradeNotice.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Tenant project id (row-level isolation on every query).

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

category

string

default: marketing

Allowed values: transactional marketing

subject

required

string

>= 1 characters <= 200 characters

previewText

string | null

<= 200 characters

editorDoc

string | null

<= 400000 characters

htmlBody

required

string

>= 1 characters <= 200000 characters

textBody

string | null

<= 200000 characters

variables

Array<string>

default: <= 100 items

status

string

default: active

Allowed values: draft active archived

attachments

Array<string>

default: <= 3 items

Responses

201

Created template.

application/json

object

template

object

string

projectId

string

name

string

category

string

Allowed values: transactional marketing

subject

string

previewText

string | null

editorDoc

TipTap canvas JSON (stored verbatim).

string | null

htmlBody

string

textBody

string | null

variables

Array<string>

status

string

Allowed values: draft active archived

attachments

Email_assets ids.

Array<string>

sourceLocale

string

createdAt

string format: date-time

updatedAt

string format: date-time

aliyunDegradeNotice

string

400

Validation error, or invalid/oversized attachment references.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

401

Not authenticated (no valid session/principal).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Authenticated but lacks the required project role.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

POST

/api/projects/{projectId}/email/templates

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/email/templates \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "category": "marketing",
8
  "subject": "<string>",
9
  "previewText": "<string>",
10
  "editorDoc": "<string>",
11
  "htmlBody": "<string>",
12
  "textBody": "<string>",
13
  "variables": [],
14
  "status": "active",
15
  "attachments": []
16
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/email/templates';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","category":"marketing","subject":"<string>","previewText":"<string>","editorDoc":"<string>","htmlBody":"<string>","textBody":"<string>","variables":[],"status":"active","attachments":[]}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/email/templates"
4

5
payload = {
6
    "name": "<string>",
7
    "category": "marketing",
8
    "subject": "<string>",
9
    "previewText": "<string>",
10
    "editorDoc": "<string>",
11
    "htmlBody": "<string>",
12
    "textBody": "<string>",
13
    "variables": [],
14
    "status": "active",
15
    "attachments": []
16
}
17
headers = {
18
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
19
    "Content-Type": "application/json"
20
}
21

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

24
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/email/templates"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"category\": \"marketing\",\n  \"subject\": \"<string>\",\n  \"previewText\": \"<string>\",\n  \"editorDoc\": \"<string>\",\n  \"htmlBody\": \"<string>\",\n  \"textBody\": \"<string>\",\n  \"variables\": [],\n  \"status\": \"active\",\n  \"attachments\": []\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/email/templates"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"category\": \"marketing\",\n  \"subject\": \"<string>\",\n  \"previewText\": \"<string>\",\n  \"editorDoc\": \"<string>\",\n  \"htmlBody\": \"<string>\",\n  \"textBody\": \"<string>\",\n  \"variables\": [],\n  \"status\": \"active\",\n  \"attachments\": []\n}")
15

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

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

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

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

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201Created template.

1
{
2
  "template": {
3
    "category": "transactional",
4
    "status": "draft"
5
  }
6
}

Create an email template

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated