トラッキングドメイン
トラッキングドメインを管理します。
クエリ
トラッキングドメインリストを取得する
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-domains
このコードブロックはフローティングウィンドウ内に表示されます
HTTP リクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
クエリパラメータの説明
| Parameter | Type | Required or not | Description |
|---|---|---|---|
| name | string | no | ドメイン |
| offset | int | no | オフセット位置、[0-]、デフォルトは 0 |
| limit | int | no | 数量、[0-100]、デフォルトは 100 |
リクエスト例
curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| Parameter | Description |
|---|---|
| domain_id | ドメイン ID |
| name | ドメイン |
| cname | ドメインの CNAME レコードの詳細 |
| verify | 設定が成功したかどうか（true または false） |
| verify_message | CNAME レコードのメッセージの説明、レコードが正しい場合は null |
| required_record | 設定が必要な CNAME レコード |
| existed_record | ユーザーが設定した CNAME レコード |
| cert | ドメイン証明書の詳細 |
| verify | 設定が成功したかどうか（true または false） |
| verify_message | 証明書が未アップロード、証明書が設定中、証明書が有効、証明書が期限切れ |
| expired_date | 有効期限 |
| create_time | ドメイン作成時間 |
| update_time | ドメイン更新時間 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": [
{
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
},
{
"domain_id": 1000402,
"name": "track.myMail.com",
"create_time": "2025-04-18T13:05:57+0800",
"update_time": "2025-04-18T13:05:57+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
},
"cert": {
"verify": false,
"verify_message": "the certificate has not been uploaded",
"expired_date": ""
}
}
],
"total": 2,
"count": 2
}
{
"result": [
{
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
},
{
"domain_id": 1000402,
"name": "track.myMail.com",
"create_time": "2025-04-18T13:05:57+0800",
"update_time": "2025-04-18T13:05:57+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
},
"cert": {
"verify": false,
"verify_message": "the certificate has not been uploaded",
"expired_date": ""
}
}
],
"total": 2,
"count": 2
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
追加
トラッキングドメインをアカウントに追加します。
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-domains
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
HTTP リクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
Body パラメータの説明
| Parameter | Type | Required or not | Description |
|---|---|---|---|
| name | string | yes | ドメイン |
注意:
最大 5 つのカスタムトラッキングドメインを追加できます。一度設定が検証されると、ドメインは変更できません。誤った設定は、メール内のリンクがクリックできなくなる、トラッキングデータが正確でなくなるなどの問題を引き起こす可能性があります。
Chrome やその他のブラウザのアップグレードにより、将来的に HTTP リソースの読み込みが禁止される可能性があります。これにより、コンテンツが誤ってブロックされたり、トラッキングデータに問題が発生する可能性があります。HTTPS 設定を行い、HTTPS トラッキングを有効にするために SSL 証明書をアップロードすることを強くお勧めします。
リクエスト例
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"track.leonww.asia"
}'
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"track.leonww.asia"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| Parameter | Description |
|---|---|
| domain_id | ドメイン ID |
| name | ドメイン |
| cname | ドメインの CNAME レコードの詳細 |
| verify | 設定が成功したかどうか（true または false） |
| verify_message | CNAME レコードのメッセージの説明、レコードが正しい場合は null |
| required_record | 設定が必要な CNAME レコード |
| existed_record | 既存の CNAME レコード |
| create_time | ドメイン作成時間 |
| update_time | ドメイン更新時間 |
レスポンス例
Response-success
HTTP Status: 200
{
"result":
{
"domain_id": 1000423,
"name": "track.leonww.asia",
"create_time": "2025-09-03T13:42:41+0800",
"update_time": "2025-09-03T13:42:41+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
}
}
}
{
"result":
{
"domain_id": 1000423,
"name": "track.leonww.asia",
"create_time": "2025-09-03T13:42:41+0800",
"update_time": "2025-09-03T13:42:41+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
}
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
{
"code": 31003,
"message": "Domain name format error"
}
{
"code": 31003,
"message": "Domain name format error"
}
このコードブロックはフローティングウィンドウ内に表示されます
修正
このインターフェースを使用してトラッキングドメインを修正します
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
HTTP リクエストメソッド
PUT
PUT
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
Body パラメータの説明
| Parameter | Type | Required or not | Description |
|---|---|---|---|
| name | string | yes | ドメイン。ドメイン形式に準拠している必要があり、英数字、ハイフン（-）、ピリオド（.）のみを含むことができます。長さは 4 ～ 255 文字である必要があります（例：mail.test.best）。 |
リクエスト例
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/22332"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"aizl.net",
}'
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/22332"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"aizl.net",
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
{
"code": 31003,
"message": "Domain name format error"
}
{
"code": 31003,
"message": "Domain name format error"
}
このコードブロックはフローティングウィンドウ内に表示されます
検証
このインターフェースを使用してトラッキングドメインを検証します
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
このコードブロックはフローティングウィンドウ内に表示されます
HTTP リクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
注意
検証済みの設定ドメインを返します。
検証済みの設定ドメインを返します。
このコードブロックはフローティングウィンドウ内に表示されます
リクエスト例
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| Parameter | Description |
|---|---|
| domain_id | ドメイン ID |
| name | ドメイン |
| cname | ドメインの CNAME レコードの詳細 |
| verify | 設定が成功したかどうか（true または false） |
| verify_message | CNAME レコードのメッセージの説明、レコードが正しい場合は null |
| required_record | 設定が必要な CNAME レコード |
| existed_record | 既存の CNAME レコード |
| cert | ドメイン証明書の詳細 |
| verify | 設定が成功したかどうか（true または false） |
| verify_message | 証明書が未アップロード、証明書が設定中、証明書が有効、証明書が期限切れ |
| expired_date | 有効期限 |
| create_time | ドメイン作成時間 |
| update_time | ドメイン更新時間 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
証明書の追加
トラッキングドメインの証明書を追加します
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
HTTP リクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Body パラメータの説明
| parameter | type | required or not | description |
|---|---|---|---|
| cert_content | string | yes | 証明書の内容を示します。値は PEM エンコード形式である必要があります。 |
| cert_key | string | yes | 証明書の秘密鍵を示します。値は PEM エンコード形式である必要があります。 |
リクエスト例
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--data '{
"cert_content":"...",
"cert_key":"...",
}'
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--data '{
"cert_content":"...",
"cert_key":"...",
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| Parameter | Description |
|---|---|
| domain_id | ドメイン ID |
| name | ドメイン |
| cert | ドメイン証明書の詳細 |
| verify | 設定が成功したかどうか（true または false） |
| verify_message | 証明書が未アップロード、証明書が設定中、証明書が有効、証明書が期限切れ |
| expired_date | 有効期限 |
| create_time | ドメイン作成時間 |
| update_time | ドメイン更新時間 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cert": {
"verify": false,
"verify_message": "the certificate is being configured",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cert": {
"verify": false,
"verify_message": "the certificate is being configured",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
証明書の更新
トラッキングドメインの証明書を更新します
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
HTTP リクエストメソッド
PUT
PUT
このコードブロックはフローティングウィンドウ内に表示されます
Body パラメータの説明
| parameter | type | required or not | description |
|---|---|---|---|
| cert_content | string | yes | 証明書の内容を示します。値は PEM エンコード形式である必要があります。 |
| cert_key | string | yes | 証明書の秘密鍵を示します。値は PEM エンコード形式である必要があります。 |
リクエスト例
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
API_USER の更新
API_USER に関連するトラッキングドメインとトラッキングスイッチの設定を更新します
URL
https://email.api.engagelab.cc/v1/api_users/{api_user}
https://email.api.engagelab.cc/v1/api_users/{api_user}
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
HTTP リクエストメソッド
PUT
PUT
このコードブロックはフローティングウィンドウ内に表示されます
正文パラメーターの説明
| パラメーター | タイプ | 必須かどうか | 説明 |
|---|---|---|---|
| domain_name | string | いいえ | API_USER にバインドされたドメイン名 |
| track_domain_name | string | いいえ | API_USER にバインドされたトラッキングドメイン名 |
| open_tracking | boolean | いいえ | 開封トラッキングを有効にするかどうか。値：false（無効）、true（有効）。デフォルト値は false。 |
| click_tracking | boolean | いいえ | クリックトラッキングを有効にするかどうか。値：false（無効）、true（有効）。デフォルト値は false。 |
| unsubscribe_tracking | boolean | いいえ | 退会トラッキングを有効にするかどうか。値：false（無効）、true（有効）。デフォルト値は true。 |
リクエスト例
curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
