Create an email campaign (draft)

Requires EDITOR. Computes audience preview counts at creation.

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

templateId

required

string

>= 1 characters

providerId

string | null

>= 1 characters

identityId

string | null

>= 1 characters

audienceFilter

required

Segment predicate shared by campaigns and trigger userFilter (all fields optional).

object

locale

One of:

string
Array<string>

string

hasEmail

boolean

hasPhone

boolean

userIdLike

string

firstSeenFrom

string format: date-time

firstSeenTo

string format: date-time

lastSeenFrom

string format: date-time

lastSeenTo

string format: date-time

savedAudienceId

string

queueKey

string

Allowed values: new_paid_activation key_created_low_usage high_balance_inactive high_value low_balance_renewal churn_risk_paid

paidStatus

One of:

string
Array<string>

string

valueTier

One of:

string
Array<string>

string

minLtv

number

maxLtv

number

minBalance

number

maxBalance

number

minUsage30d

number

maxUsage30d

number

lastPurchaseFrom

string format: date-time

lastPurchaseTo

string format: date-time

lifecycleStage

One of:

string
Array<string>

string

recommendedAction

One of:

string
Array<string>

string

variables

object

key

additional properties

any

sendRatePerSecond

integer

default: 10 >= 1 <= 100

scheduledAt

string format: date-time

Responses

201

Created campaign.

application/json

object

campaign

Email campaign (serialized). See handler for the full field set.

object

string

projectId

string

name

string

status

string

Allowed values: draft queued expanding sending paused completed aborted

templateId

string

providerId

string | null

identityId

string | null

audienceFilter

Segment predicate shared by campaigns and trigger userFilter (all fields optional).

object

locale

One of:

string
Array<string>

string

hasEmail

boolean

hasPhone

boolean

userIdLike

string

firstSeenFrom

string format: date-time

firstSeenTo

string format: date-time

lastSeenFrom

string format: date-time

lastSeenTo

string format: date-time

savedAudienceId

string

queueKey

string

Allowed values: new_paid_activation key_created_low_usage high_balance_inactive high_value low_balance_renewal churn_risk_paid

paidStatus

One of:

string
Array<string>

string

valueTier

One of:

string
Array<string>

string

minLtv

number

maxLtv

number

minBalance

number

maxBalance

number

minUsage30d

number

maxUsage30d

number

lastPurchaseFrom

string format: date-time

lastPurchaseTo

string format: date-time

lifecycleStage

One of:

string
Array<string>

string

recommendedAction

One of:

string
Array<string>

string

variables

object | null

estimatedRecipients

integer

suppressionPreview

integer

sendRatePerSecond

integer

scheduledAt

string | null format: date-time

launchAt

string | null format: date-time

expandedCount

integer

sentCount

integer

deliveredCount

integer

openedCount

integer

clickedCount

integer

failedCount

integer

suppressedCount

integer

abortedReason

string | null

quotaDeferredCount

integer

lastQuotaDeferredAt

string | null format: date-time

createdBy

string | null

createdAt

string format: date-time

updatedAt

string format: date-time

startedAt

string | null format: date-time

completedAt

string | null format: date-time

400

Request body failed Zod validation.

application/json

Validation error envelope with per-field issues.

object

error

string

issues

Array<object>

object

path

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "issues": [
4
    {
5
      "path": "example",
6
      "message": "example"
7
    }
8
  ]
9
}

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
}

404

Saved audience or sending identity not found.

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/campaigns

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/email/campaigns \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "templateId": "<string>",
8
  "providerId": "<string>",
9
  "identityId": "<string>",
10
  "audienceFilter": {
11
    "locale": "<string>",
12
    "hasEmail": true,
13
    "hasPhone": true,
14
    "userIdLike": "<string>",
15
    "firstSeenFrom": "<string>",
16
    "firstSeenTo": "<string>",
17
    "lastSeenFrom": "<string>",
18
    "lastSeenTo": "<string>",
19
    "savedAudienceId": "<string>",
20
    "queueKey": "new_paid_activation",
21
    "paidStatus": "<string>",
22
    "valueTier": "<string>",
23
    "minLtv": 0,
24
    "maxLtv": 0,
25
    "minBalance": 0,
26
    "maxBalance": 0,
27
    "minUsage30d": 0,
28
    "maxUsage30d": 0,
29
    "lastPurchaseFrom": "<string>",
30
    "lastPurchaseTo": "<string>",
31
    "lifecycleStage": "<string>",
32
    "recommendedAction": "<string>"
33
  },
34
  "variables": {},
35
  "sendRatePerSecond": 10,
36
  "scheduledAt": "<string>"
37
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/email/campaigns';
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>","templateId":"<string>","providerId":"<string>","identityId":"<string>","audienceFilter":{"locale":"<string>","hasEmail":true,"hasPhone":true,"userIdLike":"<string>","firstSeenFrom":"<string>","firstSeenTo":"<string>","lastSeenFrom":"<string>","lastSeenTo":"<string>","savedAudienceId":"<string>","queueKey":"new_paid_activation","paidStatus":"<string>","valueTier":"<string>","minLtv":0,"maxLtv":0,"minBalance":0,"maxBalance":0,"minUsage30d":0,"maxUsage30d":0,"lastPurchaseFrom":"<string>","lastPurchaseTo":"<string>","lifecycleStage":"<string>","recommendedAction":"<string>"},"variables":{},"sendRatePerSecond":10,"scheduledAt":"<string>"}'
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/campaigns"
4

5
payload = {
6
    "name": "<string>",
7
    "templateId": "<string>",
8
    "providerId": "<string>",
9
    "identityId": "<string>",
10
    "audienceFilter": {
11
        "locale": "<string>",
12
        "hasEmail": True,
13
        "hasPhone": True,
14
        "userIdLike": "<string>",
15
        "firstSeenFrom": "<string>",
16
        "firstSeenTo": "<string>",
17
        "lastSeenFrom": "<string>",
18
        "lastSeenTo": "<string>",
19
        "savedAudienceId": "<string>",
20
        "queueKey": "new_paid_activation",
21
        "paidStatus": "<string>",
22
        "valueTier": "<string>",
23
        "minLtv": 0,
24
        "maxLtv": 0,
25
        "minBalance": 0,
26
        "maxBalance": 0,
27
        "minUsage30d": 0,
28
        "maxUsage30d": 0,
29
        "lastPurchaseFrom": "<string>",
30
        "lastPurchaseTo": "<string>",
31
        "lifecycleStage": "<string>",
32
        "recommendedAction": "<string>"
33
    },
34
    "variables": {},
35
    "sendRatePerSecond": 10,
36
    "scheduledAt": "<string>"
37
}
38
headers = {
39
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
40
    "Content-Type": "application/json"
41
}
42

43
response = requests.post(url, json=payload, headers=headers)
44

45
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"templateId\": \"<string>\",\n  \"providerId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"audienceFilter\": {\n    \"locale\": \"<string>\",\n    \"hasEmail\": true,\n    \"hasPhone\": true,\n    \"userIdLike\": \"<string>\",\n    \"firstSeenFrom\": \"<string>\",\n    \"firstSeenTo\": \"<string>\",\n    \"lastSeenFrom\": \"<string>\",\n    \"lastSeenTo\": \"<string>\",\n    \"savedAudienceId\": \"<string>\",\n    \"queueKey\": \"new_paid_activation\",\n    \"paidStatus\": \"<string>\",\n    \"valueTier\": \"<string>\",\n    \"minLtv\": 0,\n    \"maxLtv\": 0,\n    \"minBalance\": 0,\n    \"maxBalance\": 0,\n    \"minUsage30d\": 0,\n    \"maxUsage30d\": 0,\n    \"lastPurchaseFrom\": \"<string>\",\n    \"lastPurchaseTo\": \"<string>\",\n    \"lifecycleStage\": \"<string>\",\n    \"recommendedAction\": \"<string>\"\n  },\n  \"variables\": {},\n  \"sendRatePerSecond\": 10,\n  \"scheduledAt\": \"<string>\"\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/campaigns"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"templateId\": \"<string>\",\n  \"providerId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"audienceFilter\": {\n    \"locale\": \"<string>\",\n    \"hasEmail\": true,\n    \"hasPhone\": true,\n    \"userIdLike\": \"<string>\",\n    \"firstSeenFrom\": \"<string>\",\n    \"firstSeenTo\": \"<string>\",\n    \"lastSeenFrom\": \"<string>\",\n    \"lastSeenTo\": \"<string>\",\n    \"savedAudienceId\": \"<string>\",\n    \"queueKey\": \"new_paid_activation\",\n    \"paidStatus\": \"<string>\",\n    \"valueTier\": \"<string>\",\n    \"minLtv\": 0,\n    \"maxLtv\": 0,\n    \"minBalance\": 0,\n    \"maxBalance\": 0,\n    \"minUsage30d\": 0,\n    \"maxUsage30d\": 0,\n    \"lastPurchaseFrom\": \"<string>\",\n    \"lastPurchaseTo\": \"<string>\",\n    \"lifecycleStage\": \"<string>\",\n    \"recommendedAction\": \"<string>\"\n  },\n  \"variables\": {},\n  \"sendRatePerSecond\": 10,\n  \"scheduledAt\": \"<string>\"\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 campaign.

1
{
2
  "campaign": {
3
    "status": "draft",
4
    "audienceFilter": {
5
      "queueKey": "new_paid_activation"
6
    }
7
  }
8
}

Create an email campaign (draft)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated