タグ管理
呼び出しアドレス
| データセンター | URL |
|---|---|
| シンガポール | https://email.api.engagelab.cc |
| トルコ | https://emailapi-tr.engagelab.com |
REST APIを使用する際は、選択したデータセンターが適切なベースURLに対応していることを確認してください。
POST/v1/marketing/lists/tags
タグ作成
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags
https://email.api.engagelab.cc/v1/marketing/lists/tags
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
ボディパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| tag_name | string | true | タグ名、最大64文字、a-z、A-Z、0-9、_、中国語文字などで構成されます。 |
リクエスト例
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags --data '{
"name": "myCustomTag"
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags --data '{
"name": "myCustomTag"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus:200
{
"result":{
"tag_id": "62732d3ddd017d22ccd118e4",
"tag_name": "education",
"create_time": "2023-11-28T11:14:48+0800",
"update_time": "2023-11-28T11:14:48+0800",
}
}
{
"result":{
"tag_id": "62732d3ddd017d22ccd118e4",
"tag_name": "education",
"create_time": "2023-11-28T11:14:48+0800",
"update_time": "2023-11-28T11:14:48+0800",
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
タグ削除
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_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/tags/61c2be010d2b4e6a3836ab1f
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
{
"code": 30036,
"message": "resource not found"
}
{
"code": 30036,
"message": "resource not found"
}
このコードブロックはフローティングウィンドウ内に表示されます
タグ更新
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_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) |
ボディパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| tag_name | string | false | タグ名、最大64文字、a-z、A-Z、0-9、_、中国語文字などで構成されます。 |
リクエスト例
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 61c2be010d2b4e6a3836ab1f --data '{
"name": "myCustomTag"
}'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 61c2be010d2b4e6a3836ab1f --data '{
"name": "myCustomTag"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: 400
{
"code": 30035,
"message": "Tag name only consists of a-z, A-z, 0-9, _,chinese character, up to 64 characters"
}
{
"code": 30035,
"message": "Tag name only consists of a-z, A-z, 0-9, _,chinese character, up to 64 characters"
}
このコードブロックはフローティングウィンドウ内に表示されます
タグリスト
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags
https://email.api.engagelab.cc/v1/marketing/lists/tags
このコードブロックはフローティングウィンドウ内に表示されます
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) |
クエリパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| tag_name | string | false | クエリするタグ名（あいまい検索をサポート） |
| offset | integer | false | クエリ開始位置、範囲[0-]、デフォルトは0 |
| limit | integer | false | クエリ数、範囲[1-100]、デフォルトは10 |
リクエスト例
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| パラメータ | タイプ | 説明 |
|---|---|---|
| result | array[object] | 連絡先リスト |
| tag_id | string | タグID |
| tag_name | string | タグ名 |
| create_time | string | 作成時間 |
| update_time | string | 更新時間 |
| count | integer | このタグを持つ連絡先の数 |
| total | integer | クエリに一致するレコードの総数 |
| count | integer | 返されたレコードの総数 |
レスポンス例
Response-Success
HttpStatus: 200
{
"result": [
{
"tag_id": "617a71ac672b2823a1a82c13",
"tag_name": "education",
"create_time": "2023-11-28T11:14:48+0800",
"update_time":"2023-11-28T11:14:48+0800",
"count": 1,
}
],
"count": 1,
"total": 1
}
{
"result": [
{
"tag_id": "617a71ac672b2823a1a82c13",
"tag_name": "education",
"create_time": "2023-11-28T11:14:48+0800",
"update_time":"2023-11-28T11:14:48+0800",
"count": 1,
}
],
"count": 1,
"total": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
タグを連絡先に追加
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
ボディパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| member_ids | string[] | true | 連絡先IDのリスト、1リクエストにつき最大1000件まで |
リクエスト例
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f/add --data '{
"member_ids": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f/add --data '{
"member_ids": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"count": 2
}
{
"count": 2
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
タグを連絡先から削除
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Bearer Token |
ボディパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| member_ids | array[string] | true | 連絡先IDのリスト、1リクエストにつき最大1000件まで |
リクエスト例
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/ 616683a13a7b531b0336108d/remove --data '{
"memberIds": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/ 616683a13a7b531b0336108d/remove --data '{
"memberIds": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus:200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
HttpStatus: 401
Response-Error
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
連絡先取得
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/members
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/members
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Bearer Token |
クエリ説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| offset | integer | false | クエリ開始位置、範囲[0-]、デフォルトは0 |
| limit | integer | false | クエリ数、範囲[1-100]、デフォルトは10 |
リクエスト例
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit= 10
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit= 10
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| パラメータ | タイプ | 説明 |
|---|---|---|
| result | object | 連絡先リスト |
| member_id | string | 連絡先ID |
| list_id | integer | リストID |
| string | メールアドレス | |
| phone | string | 電話番号 |
| name | string | 名前 |
| create_time | string | 作成時間 (UTC+8) |
| update_time | string | 更新時間 (UTC+8) |
| unsubscribe_time | string | 退会時間 (UTC+8) |
| fields | object | 連絡先属性 |
| tag_ids | array[string] | タグIDコレクション |
| tag_names | array[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": [
"646f28a7cac6587565ad6918"
],
"tag_names": [
"test"
],
"create_time": "2023-11-28T18:30:02+0800",
"update_time": "2023-11-30T16:42:11+0800",
"unsubscribe_time": null
}
],
"total": 2,
"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": [
"646f28a7cac6587565ad6918"
],
"tag_names": [
"test"
],
"create_time": "2023-11-28T18:30:02+0800",
"update_time": "2023-11-30T16:42:11+0800",
"unsubscribe_time": null
}
],
"total": 2,
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
