Update a sending identity

Requires EDITOR. channelId is immutable. Cannot directly un-default (409) — switch default by promoting another identity. Pausing the sole/default identity may 409.

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; channelId is immutable and not accepted here.

object

label

string

>= 1 characters <= 120 characters

fromAddress

string format: email

fromName

string | null

<= 120 characters

replyToAddress

string | null format: email

isDefault

boolean

status

string

Allowed values: active paused

Responses

200

Updated identity (+ optional notices).

application/json

object

identity

object

string

projectId

string

channelId

string

label

string

fromAddress

string format: email

fromName

string | null

replyToAddress

string | null format: email

isDefault

boolean

status

string

Allowed values: active paused

createdAt

string | null format: date-time

updatedAt

string | null format: date-time

domainWarning

string

aliyunNotice

string

400

Validation error, or default/paused constraint violation.

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
}

409

Cannot un-default directly, pause last default, or duplicate from-address.

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/identities/{id}

1
curl --request PATCH \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/email/identities/%3Cstring%3E \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "label": "<string>",
7
  "fromAddress": "<string>",
8
  "fromName": "<string>",
9
  "replyToAddress": "<string>",
10
  "isDefault": true,
11
  "status": "active"
12
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/email/identities/%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: '{"label":"<string>","fromAddress":"<string>","fromName":"<string>","replyToAddress":"<string>","isDefault":true,"status":"active"}'
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/identities/%3Cstring%3E"
4

5
payload = {
6
    "label": "<string>",
7
    "fromAddress": "<string>",
8
    "fromName": "<string>",
9
    "replyToAddress": "<string>",
10
    "isDefault": True,
11
    "status": "active"
12
}
13
headers = {
14
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
15
    "Content-Type": "application/json"
16
}
17

18
response = requests.patch(url, json=payload, headers=headers)
19

20
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"label\": \"<string>\",\n  \"fromAddress\": \"<string>\",\n  \"fromName\": \"<string>\",\n  \"replyToAddress\": \"<string>\",\n  \"isDefault\": true,\n  \"status\": \"active\"\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/identities/%3Cstring%3E"
13

14
  payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"fromAddress\": \"<string>\",\n  \"fromName\": \"<string>\",\n  \"replyToAddress\": \"<string>\",\n  \"isDefault\": true,\n  \"status\": \"active\"\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
}

200Updated identity (+ optional notices).

1
{
2
  "identity": {
3
    "status": "active"
4
  }
5
}

Update a sending identity

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated