logoドキュメント
Email
ドキュメントホーム
クイックスタート手順REST APISMTPUseMarketingWebHookリソース
検索
日本語
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
ログイン
REST API / アドレスリスト

アドレスリスト

最新更新：2025-07-22

アドレスリストは、ユーザーによる一括送信に使用されます。

APIを使用して、アドレスリストを照会、追加、変更、削除することができます。

また、アドレスリスト内のアドレスメンバーを照会、追加、変更、削除することも可能です。

アドレスリストの照会（バッチ照会）

URL

https://email.api.engagelab.cc/v1/address_lists
              
              https://email.api.engagelab.cc/v1/address_lists
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET
              
              GET
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

クエリパラメータの説明

パラメータ タイプ 必須 説明
offset int No 照会開始位置、範囲[0-]、デフォルトは0。
limit int No 照会数、範囲[0-100]、デフォルトは100。
name string No リスト名。あいまい検索。
address string No エイリアスアドレス。完全一致検索。

リクエスト例

curl 'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
              
              curl  'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

フィールド 説明
address_list_id アドレスリストID
name リスト名
address エイリアスアドレス。呼び出しに使用され、形式はxxx@maillist.email.engagelab.com。
member_count アドレスリストに含まれるアドレス数
desc アドレスリストの説明
create_time アドレスリスト作成時間
update_time アドレスリスト修正時間

レスポンス例

Response-success

HTTP Status: 200

{ "result": [ { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "Description": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } ], "total": 1, "count": 1 }
              
              {
  "result": [
            {
                "address_list_id": 65499,
                "address": "jg2@maillist.email.engagelab.com",
                "name": "1113-mailist",
                "member_count": 2,
                "Description": "desc222ss",
                "create_time": "2022-11-12T16:46:12+0800",
                "update_time": "2022-11-12T16:50:01+0800"
            }
        ],
        "total": 1,
        "count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます

アドレスリストの照会

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET
              
              GET
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

リクエスト例

curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

フィールド 説明
address_list_id アドレスリストID
name リスト名
address エイリアスアドレス。呼び出しに使用され、形式はxxx@maillist.email.engagelab.com。
member_count アドレスリストに含まれるアドレス数
desc アドレスリストの説明
create_time アドレスリスト作成時間
update_time アドレスリスト修正時間

レスポンス例

Response-success

HTTP Status: 200

{ "result": { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "Description": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } }
              
              {
  "result":
            {
                "address_list_id": 65499,
                "address": "jg2@maillist.email.engagelab.com",
                "name": "1113-mailist",
                "member_count": 2,
                "Description": "desc222ss",
                "create_time": "2022-11-12T16:46:12+0800",
                "update_time": "2022-11-12T16:50:01+0800"
            }
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます

アドレスリストの追加

URL

https://email.api.engagelab.cc/v1/address_lists
              
              https://email.api.engagelab.cc/v1/address_lists
このコードブロックはフローティングウィンドウ内に表示されます

Content-Type:

Content-Type: application/json;charset=utf-8
              
              Content-Type: application/json;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

POST
              
              POST
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

ボディパラメータ

パラメータ タイプ 必須 説明
name string Yes リスト名。最大48文字。
address string Yes エイリアスアドレス。メールアドレス形式、例: marketing@maillist.email.engagelab.com。
desc string No 説明。最大255文字。

リクエスト例

curl -X POST "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"scgd@email.engagelab.com", "name":"hongKong", "desc":"" }'
              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"scgd@email.engagelab.com",
"name":"hongKong",
"desc":""
}'
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

フィールド 説明
address_list_id リストID
name リスト名
address エイリアスアドレス
member_count リスト内のアドレス数
desc リストの説明
create_time アドレスリスト作成時間
update_time アドレスリスト修正時間

レスポンス例

response success { "result": { "address_list_id": 65504, "address": "jg3@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 0, "desc": "desc", "create_time": "2022-11-15T16:25:02+0800", "update_time": "2022-11-15T16:25:02+0800" } } response error { "code": 30000, "message": "Authentication failed." }
              
              response success
{
     "result": {
            "address_list_id": 65504,
            "address": "jg3@maillist.email.engagelab.com",
            "name": "1113-mailist",
            "member_count": 0,
            "desc": "desc",
            "create_time": "2022-11-15T16:25:02+0800",
            "update_time": "2022-11-15T16:25:02+0800"
        }
}

response error
{ 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます

アドレスリストの削除

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

DELETE
              
              DELETE
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

リクエスト例

curl -X DELETE "https://email.api.engagelab.cc/v1/address_list/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://email.api.engagelab.cc/v1/address_list/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

パラメータ 説明
count 成功した削除項目数

レスポンス例

Response-success

HTTP Status: 200

{ "count": 1 }
              
              {
  "count": 1   
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます

アドレスリストの変更

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
このコードブロックはフローティングウィンドウ内に表示されます

Content-Type:

Content-Type: application/json;charset=utf-8
              
              Content-Type: application/json;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

PUT
              
              PUT
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

ボディパラメータの説明

パラメータ タイプ 必須 説明
address string No エイリアスアドレス。呼び出しに使用され、形式はxxx@@maillist.email.engagelab.com
name string No 修正後のリスト名。最大48文字。
desc string No 修正後のリスト説明。最大255文字。

説明

【name】または【desc】の組み合わせ
              
              【name】または【desc】の組み合わせ
このコードブロックはフローティングウィンドウ内に表示されます

リクエスト例

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"new@maillist.email.engagelab.com", "name":"GZ", "desc":"2" }'
              
              curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"new@maillist.email.engagelab.com",
"name":"GZ",
"desc":"2"
}'
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

フィールド 説明
count 成功した修正項目数

レスポンス例

Response-success

HTTP Status: 200

{ "count": 1 }
              
               { 
   "count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます

リストメンバーの照会

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET
              
              GET
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

クエリパラメータの説明

パラメータ タイプ 必須 説明
offset int No 照会開始位置、範囲[0-]、デフォルトは0。
limit int No 照会数、範囲[0-100]、デフォルトは100。
email string No メンバーのメールアドレスを照会。あいまい検索をサポート。
member_ids string No メンバーID、セミコロンで区切る。最大100件。

リクエスト例

curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20 --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20 --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

フィールド 説明
member_id メンバーID
email メンバーのメールアドレス
name メンバー名
vars 変数
create_time 作成時間
update_time 更新時間

レスポンス例

Response-success

HTTP Status: 200

{ "result": [ { "member_id": "11719293", "email": "example2@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-13 11:23:44", "update_time": "2022-11-13 11:23:44" }, { "member_id": "11719294", "email": "example5@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-15 16:34:47", "update_time": "2022-11-15 16:34:47" } ], "total": 2, "count": 2, "address_list_id": "65499" }
              
              {
    "result": [
        {
            "member_id": "11719293",
            "email": "example2@abc.com",
            "name": null,
            "vars": "{\"loc\":\"sss\"}",
            "create_time": "2022-11-13 11:23:44",
            "update_time": "2022-11-13 11:23:44"
        },
        {
            "member_id": "11719294",
            "email": "example5@abc.com",
            "name": null,
            "vars": "{\"loc\":\"sss\"}",
            "create_time": "2022-11-15 16:34:47",
            "update_time": "2022-11-15 16:34:47"
        }
    ],
    "total": 2,
    "count": 2,
    "address_list_id": "65499"
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます

リストメンバーの追加

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
このコードブロックはフローティングウィンドウ内に表示されます

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

POST
              
              POST
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

ボディパラメータの説明

パラメータ タイプ 必須 説明
members array[object] Yes メンバー。最大1000件。
email string Yes メンバーのメールアドレス。メール形式。
name string No ニックネーム。最大128文字。
vars object No 変数。最大サイズは1KB。

説明

1.vars変数を追加する際、キーに'%'を含める必要はなく、キーの長さは32文字を超えてはなりません。 2.vars変数内のキー名がnameと一致する場合、パラメータnameによって上書きされます。 3.アドレスリストを送信する際、グローバル変数recipientを使用できます。これは受信者のメールアドレスです。
              
              1.vars変数を追加する際、キーに'%'を含める必要はなく、キーの長さは32文字を超えてはなりません。
2.vars変数内のキー名がnameと一致する場合、パラメータnameによって上書きされます。
3.アドレスリストを送信する際、グローバル変数recipientを使用できます。これは受信者のメールアドレスです。
このコードブロックはフローティングウィンドウ内に表示されます

リクエスト例

curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

フィールド 説明
count 成功したアドレス数
invalid 失敗したアドレス
invalidCount 失敗したメールアドレスの数
reasonList 失敗したメールアドレスの理由（アドレス詳細と一対一対応）

レスポンス例

Response-success

HTTP Status: 200

{ "result": { "count": 2, "invalidCount": 1, "invalid": [ "wang.@yahoo.com" ], "reasonList": [ "Member email format erorr" ] } }
              
              {
    "result": {
        "count": 2,
        "invalidCount": 1,
        "invalid": [
            "wang.@yahoo.com"
        ],
        "reasonList": [
            "Member email format erorr"
        ]
    }
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます

リストメンバーの変更

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
このコードブロックはフローティングウィンドウ内に表示されます

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

PUT
              
              PUT
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

ボディパラメータの説明

パラメータ タイプ 必須 説明
email string No メンバーのメールアドレス。メール形式。
name string No ニックネーム。最大128文字。
vars object No 変数。最大サイズは1KB。キーの長さは32文字を超えてはなりません。

リクエスト例

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"email":"x@engagelab.com","name":"jim"}'
              
              curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"email":"x@engagelab.com","name":"jim"}'
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

フィールド 説明
count 正常に変更されたアドレスの数
reason 失敗の理由（成功時にはこのフィールドは存在しません）

レスポンス例

Response-success

HTTP Status: 200

{ "count": 0, "reason": "Member email format erorr" }
              
              {
    "count": 0,
    "reason": "Member email format erorr" 
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます

リストメンバーの削除

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
このコードブロックはフローティングウィンドウ内に表示されます

HTTP リクエストメソッド

DELETE
              
              DELETE
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(api_user:api_key)

クエリパラメータの説明

パラメータ タイプ 必須 説明
member_ids string yes 削除するメンバーのアドレス。複数のアドレスは ; で区切り、最大100メンバーまで指定可能。

リクエスト例

curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

フィールド 説明
count 正常に削除されたアドレスの数

レスポンス例

Response-success

HTTP Status: 200

{ "count": 1}
              
               { "count": 1}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます
icon
お問い合わせ