連絡先管理

連絡先の一括追加または更新

URL

https://email.api.engagelab.cc/v1/marketing/lists/members

              
              https://email.api.engagelab.cc/v1/marketing/lists/members

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

HTTPリクエストメソッド

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

リクエストヘッダー

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

ボディパラメータ

パラメータ	タイプ	必須	説明
members	array[object]	true	連絡先リスト、最大数は1000
email	string	true	メールアドレス
phone	string	false	電話番号
name	string	false	ニックネーム
fields	object	false	連絡先属性
tags	string[]	false	タグ名リスト
tag_flag	integer	false	タグ更新方法、0: 上書き、1: 追加、2: スキップ、デフォルトは1
update_existing	boolean	true	属性を更新するかどうか（リストにアドレスが存在する場合）

注意事項:

連絡先のEmailフィールドがmembers.emailの値と一致する場合、連絡先は更新されます。それ以外の場合、新しい連絡先が追加されます。
tag_flagの異なる値とそれに対応するタグ更新方法については、以下の例を参照してください。

tag_flag	元のタグ	パラメータタグ	新しいタグ
0	[1,2,3]	[]	[]
0	[1,2,3]	null, 未指定	[1,2,3]
0	[1,2,3]	[3,4,5]	[3,4,5]
1	[1,2,3]	[]	[1,2,3]
1	[1,2,3]	null, 未指定	[1,2,3]
1	[1,2,3]	[3,4,5]	[1,2,3,4,5]
2	[1,2,3]	[]	[1,2,3]
2	[1,2,3]	null, 未指定	[1,2,3]
2	[1,2,3]	[3,4,5]	[1,2,3]
2	[]	[3,4,5]	[]

リクエスト例

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members --data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' 
-i https://email.api.engagelab.cc/v1/marketing/lists/members 
--data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'

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

レスポンス例

Response-Success

HttpStatus: 200

{ "created_count": 2, "created_members": [{ "email": "202205ab233444444444446@qq.com", "member_id": "6294b0fa490f33c5ee3b5b0c" },{ "email": "202205ab3331@qq.com", "member_id": "6294b0fa490f33c5ee3b5b0d" }], "updated_count": 2, "updated_members": [{ "email": "202205ab233444444444447@qq.com", "member_id": "6294b0fa490f33c5ee3b5b1c" },{ "email": "202205ab3332@qq.com", "member_id": "6294b0fa490f33c5ee3b5b1d" }], "error_count": 2, "error_members": [{ "email": "202205ab233444444444446@qq.com", "message": "..." },{ "email": "202205ab3331@qq.com", "message": "..." }] }

              
              {
    "created_count": 2,
    "created_members": [{
            "email": "202205ab233444444444446@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b0c"
        },{
            "email": "202205ab3331@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b0d"
    }],
    "updated_count": 2,
    "updated_members": [{
            "email": "202205ab233444444444447@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b1c"
        },{
            "email": "202205ab3332@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b1d"
    }],
    "error_count": 2,
    "error_members": [{
            "email": "202205ab233444444444446@qq.com",
            "message": "..."
        },{
            "email": "202205ab3331@qq.com",
            "message": "..."
    }]
}

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

Response-Error

{ "code": 30000, "message": "Authentication failed" }

              
              {
    
    "code": 30000,
    "message": "Authentication failed"
      
}

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

単一連絡先の削除

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

HTTPリクエストメソッド

DELETE

              
               DELETE

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

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

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

リクエストヘッダー

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

リクエスト例

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8

              
              curl -X DELETE -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8

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

レスポンス例

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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

連絡先の一括削除

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/delete

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/delete

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

HTTPリクエストメソッド

DELETE

              
              DELETE

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

リクエストヘッダー

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

ボディパラメータ

パラメータ	タイプ	必須	説明
condition	object	false	クエリ条件
relation	string	true	条件の関係 (and または or)
items	object[]	true	フィルター条件: 最大10個のフィルター条件をサポートし、すべての条件はandまたはorでなければなりません
field_name	string	true	field_nameは属性名、valueは属性値; field_nameがtagの場合、value=タグ名
op	string	true	演算子 (== , != , > , >= , < , <= , exist , contain , does not contain)
value	string	true	field_nameがtagの場合、value=タグ名 field_nameが属性名の場合、フィルター条件に従ってフォーマット

注意事項:

field_nameとopの関係はフィルター条件を参照してください。

リクエスト例

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data ' { "condition": { "relation": "or", "items": [ { "field_name": "Email", "op": "contain", "value": "hotmail.com" }, { "field_name": "Phone", "op": "contain", "value": "188" } ] } } '

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data '
{
    "condition": {
        "relation": "or",
        "items": [
            {
                "field_name": "Email",
                "op": "contain",
                "value": "hotmail.com"
            },
            {
                "field_name": "Phone",
                "op": "contain",
                "value": "188"
            }
        ]
    }
}
'

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

レスポンス例

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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

単一連絡先の更新

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

HTTPリクエストメソッド

PUT

PUT

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

リクエストヘッダー

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

ボディパラメータ

パラメータ	タイプ	必須	説明
phone	string	false	電話番号
name	string	false	ニックネーム
fields	object	false	連絡先属性
tags	string[]	false	タグ名リスト

リクエスト例

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 --data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i 
https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 
--data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'

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

レスポンス説明

パラメータ	タイプ	説明
member_id	string	連絡先ID
list_id	integer	リストID
user_id	integer	ユーザーID
email	string	メールアドレス
phone	string	電話番号
name	string	名前
create_time	string	作成時間 (UTC+8)
update_time	string	購読更新時間 (UTC+8)
unsubscribe_time	string	購読解除時間 (UTC+8)
fields	object	連絡先属性
tags	string[]	タグIDコレクション
tag_names	string[]	タグ名コレクション

レスポンス例

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
     "count": 1
}

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

Response-Error

HttpStatus: 200

{ "code": 30036, "message": "resource not found" }

              
              {
    "code": 30036,
    "message": "resource not found"
}

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

連絡先の詳細

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

HTTPリクエストメソッド

GET

GET

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

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

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

リクエストヘッダー

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

リクエスト例

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2

              
              curl -X GET -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2

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

レスポンス説明

パラメータ	タイプ	説明
member_id	string	連絡先ID
list_id	integer	リストID
email	string	メールアドレス
phone	string	電話番号
name	string	名前
create_time	string	作成時間 (UTC+8)
update_time	string	購読更新時間 (UTC+8)
unsubscribe_time	string	購読解除時間 (UTC+8)
fields	object	連絡先属性
tag_ids	string[]	タグIDコレクション
tag_names	string[]	タグ名コレクション

Response-Success

HttpStatus: 200

{ "result": { "member_id": "6565c12a3b4e0d83d3f58ea0", "list_id": 95964, "email": "xjmfc@126.com", "phone": null, "name": null, "fields": { "Birthday": "03/30", "Age": "12" }, "tag_ids": [], "tag_names": [], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T16:44:44+0800", "unsubscribe_time": null } }

              
              {
    "result": {
        "member_id": "6565c12a3b4e0d83d3f58ea0",
        "list_id": 95964,
        "email": "xjmfc@126.com",
        "phone": null,
        "name": null,
        "fields": {
            "Birthday": "03/30",
            "Age": "12"
        },
        "tag_ids": [],
        "tag_names": [],
        "create_time": "2023-11-28T18:30:02+0800",
        "update_time": "2023-11-30T16:44:44+0800",
        "unsubscribe_time": null
    }
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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

連絡先リスト

URL

https://email.api.engagelab.cc/v1/marketing/lists/list_members

              
              https://email.api.engagelab.cc/v1/marketing/lists/list_members

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

HTTPリクエストメソッド

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

リクエストヘッダー

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

クエリパラメータ

パラメータ	タイプ	必須	説明
limit	integer	false	クエリ数、範囲[1-100]、デフォルトは10
offset	integer	false	クエリ開始位置、範囲[0-]、デフォルトは0

ボディパラメータ

パラメータ	タイプ	必須	説明
condition	object	false	クエリ条件
relation	string	true	条件の関係 (and または or)
items	object[]	true	フィルター条件: 最大10個のフィルター条件をサポートし、すべての条件はandまたはorでなければなりません
field_name	string	true	field_nameは属性名、valueは属性値; field_nameがtagの場合、value=タグ名
op	string	true	演算子 (== , != , > , >= , < , <= , exist , contain , does not contain)
value	string	true	field_nameがtagの場合、value=タグ名 field_nameが属性名の場合、フィルター条件に従ってフォーマット

注意事項:

field_nameとopの関係はフィルター条件を参照してください。

リクエスト例

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/listMembers?offset=0&limit=10 --data '{ "condition": { "relation": "and", "items": [ { "field_name": "Email", "op": "contain", "value": "qq.com" } ] } }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/listMembers?offset=0&limit=10 --data '{
    "condition": {
        "relation": "and",
        "items": [
            { 
              "field_name": "Email",
              "op": "contain",
              "value": "qq.com"
            }
        ]
    }
}'

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

レスポンスパラメータ

パラメータ	タイプ	説明
list	array	リスト配列
member_id	string	メンバーID
list_id	integer	リストID
email	string	メールアドレス
phone	string	電話番号
name	string	名前
create_time	string	作成日時 (UTC+8)
update_time	string	更新日時 (UTC+8)
unsubscribe_time	string	購読解除日時 (UTC+8)
fields	object	メンバー属性
tag_ids	string[]	タグID集
tag_names	string[]	タグ名集
total	integer	総レコード数

レスポンス例

Response-Success

HttpStatus: 200

{ "result": [ { "member_id": "6565c12a3b4e0d83d3f58ea0", "list_id": 95964, "email": "xjmfc@126.com", "phone": null, "name": null, "fields": { "Birthday": "03/30", "Age": "12" }, "tag_ids": [], "tag_names": [], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T17:00:19+0800", "unsubscribe_time": null } ], "total": 3, "count": 1 }

              
              {
    "result": [
        {
            "member_id": "6565c12a3b4e0d83d3f58ea0",
            "list_id": 95964,
            "email": "xjmfc@126.com",
            "phone": null,
            "name": null,
            "fields": {
                "Birthday": "03/30",
                "Age": "12"
            },
            "tag_ids": [],
            "tag_names": [],
            "create_time": "2023-11-28T18:30:02+0800",
            "update_time": "2023-11-30T17:00:19+0800",
            "unsubscribe_time": null
        }
    ],
    "total": 3,
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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