Partially update an email channel

Requires EDITOR. Partial update. Switching kind requires resubmitting the full config. Quota fields are re-pushed to the RateBudget Durable Object after write.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

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

required

string

Resource id.

Request Body^required

application/json

Partial update; all fields optional. Changing kind requires resubmitting config.

object

name

string

>= 1 characters <= 120 characters

kind

string

Allowed values: log resend sendgrid mailgun aliyun cf_email

status

string

Allowed values: active paused disabled

fromAddress

string format: email

replyToAddress

string | null format: email

config

object

key

additional properties

string

rateLimitPerSecond

integer

>= 1 <= 100

dailyLimit

integer | null

>= 1

transactionalReservePercent

integer

<= 100

marketingDailyLimit

integer | null

>= 1

Responses

200

Acknowledged.

application/json

object

boolean

400

Validation error, or kind changed without full config.

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
}

404

Resource not found (or belongs to another project — indistinguishable).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

PATCH

/api/projects/{projectId}/email/providers/{id}

1
curl --request PATCH \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/email/providers/%3Cstring%3E \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "kind": "log",
8
  "status": "active",
9
  "fromAddress": "<string>",
10
  "replyToAddress": "<string>",
11
  "config": {},
12
  "rateLimitPerSecond": 0,
13
  "dailyLimit": 0,
14
  "transactionalReservePercent": 0,
15
  "marketingDailyLimit": 0
16
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/email/providers/%3Cstring%3E';
2
const options = {
3
  method: 'PATCH',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","kind":"log","status":"active","fromAddress":"<string>","replyToAddress":"<string>","config":{},"rateLimitPerSecond":0,"dailyLimit":0,"transactionalReservePercent":0,"marketingDailyLimit":0}'
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/providers/%3Cstring%3E"
4

5
payload = {
6
    "name": "<string>",
7
    "kind": "log",
8
    "status": "active",
9
    "fromAddress": "<string>",
10
    "replyToAddress": "<string>",
11
    "config": {},
12
    "rateLimitPerSecond": 0,
13
    "dailyLimit": 0,
14
    "transactionalReservePercent": 0,
15
    "marketingDailyLimit": 0
16
}
17
headers = {
18
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
19
    "Content-Type": "application/json"
20
}
21

22
response = requests.patch(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/providers/%3Cstring%3E"
5

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"kind\": \"log\",\n  \"status\": \"active\",\n  \"fromAddress\": \"<string>\",\n  \"replyToAddress\": \"<string>\",\n  \"config\": {},\n  \"rateLimitPerSecond\": 0,\n  \"dailyLimit\": 0,\n  \"transactionalReservePercent\": 0,\n  \"marketingDailyLimit\": 0\n}")
9

10
response = httpx.patch(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/providers/%3Cstring%3E"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"kind\": \"log\",\n  \"status\": \"active\",\n  \"fromAddress\": \"<string>\",\n  \"replyToAddress\": \"<string>\",\n  \"config\": {},\n  \"rateLimitPerSecond\": 0,\n  \"dailyLimit\": 0,\n  \"transactionalReservePercent\": 0,\n  \"marketingDailyLimit\": 0\n}")
15

16
  req, _ := http.NewRequest("PATCH", 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
}

200Acknowledged.

1
{
2
  "ok": true
3
}

Partially update an email channel

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated