キャンペーンタグ管理

ベースURL (Endpoint)

データセンター	URL
シンガポール	https://email.api.engagelab.cc
トルコ	https://emailapi-tr.engagelab.com

REST API を使用する際は、選択したベース URL と具体的な API パスを組み合わせて、完全なエンドポイント URL を取得してください。

POST/v1/marketing/campaigns/tags

キャンペーンタグの作成

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

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

HTTP リクエストメソッド

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

リクエストヘッダー (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

ボディパラメータ (Body Parameters)

Parameter	Type	Required	Description
tag_names	array[string]	true	タグ名。最大長さは 64 文字。a-z, A-Z, 0-9, _, 漢字などのみサポート。

注意点：

各組織（Organization）で作成できるタグは最大 100 個までです。
タグ名は重複できません。

リクエスト例 (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{ "tag_names": ["イレブンセール", "新規ユーザー"] }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{
    "tag_names": ["イレブンセール", "新規ユーザー"]
}'

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

レスポンス例 (Response Example)

Response-Success

HttpStatus: 200

{ "count": 2 }

              
              {
    "count": 2
}

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

Response-Error

HttpStatus: 401

{ "code": 32603, "message": "tag name already exist" }

              
              {
    "code": 32603,
    "message": "tag name already exist"
}

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

キャンペーンタグ一覧

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

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

HTTP リクエストメソッド

GET

GET

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

Content-Type

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

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

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

リクエストヘッダー (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

クエリパラメータ (Query Parameters)

Parameter	Type	Required	Description
tag_name	string	false	タグ名（あいまい検索）
offset	integer	false	記録のオフセット値。設定範囲 [0-]、デフォルトは 0
limit	integer	false	取得する記録件数。設定範囲 [1-100]、デフォルトは 10

リクエスト例 (Request Example)

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=セール&limit=10&offset=0](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=セール&limit=10&offset=0)

              
              curl -X GET -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=セール&limit=10&offset=0](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=セール&limit=10&offset=0)

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

レスポンスフィールド (Response Fields)

Parameter	Type	Description
tag_id	string	タグ ID
tag_name	string	タグ名
create_time	string	作成日時
update_time	string	更新日時

レスポンス例 (Response Example)

Response-Success

HttpStatus: 200

{ "result": [ { "tag_id": "64a1f2e0c9e1a23456789012", "tag_name": "イレブンセール", "create_time": "2024-01-15T10:30:00+0800", "update_time": "2024-01-16T14:20:00+0800" }, { "tag_id": "64a1f2e0c9e1a23456789013", "tag_name": "新規ユーザー", "create_time": "2024-01-14T08:00:00+0800", "update_time": "2024-01-14T08:00:00+0800" } ], "total": 2, "count": 2 }

              
              {
    "result": [
        {
            "tag_id": "64a1f2e0c9e1a23456789012",
            "tag_name": "イレブンセール",
            "create_time": "2024-01-15T10:30:00+0800",
            "update_time": "2024-01-16T14:20:00+0800"
        },
        {
            "tag_id": "64a1f2e0c9e1a23456789013",
            "tag_name": "新規ユーザー",
            "create_time": "2024-01-14T08:00:00+0800",
            "update_time": "2024-01-14T08:00:00+0800"
        }
    ],
    "total": 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/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}

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

HTTP リクエストメソッド

PUT

PUT

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

リクエストヘッダー (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

パスパラメータ (Path Parameters)

Parameter	Type	Required	Description
tag_id	string	true	タグ ID

ボディパラメータ (Body Parameters)

Parameter	Type	Required	Description
tag_name	string	true	タグ名。漢字、英数字、アンダースコア（_）のみサポート。長さは 1-64 文字。

リクエスト例 (Request Example)

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{ "tag_name": "年中セール" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{
    "tag_name": "年中セール"
}'

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

レスポンス例 (Response Example)

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }

              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}

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

キャンペーンタグの削除

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

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

HTTP リクエストメソッド

DELETE

              
              DELETE

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

Content-Type

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

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

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

リクエストヘッダー (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

注意点：

タグを削除すると、関連付けられていたキャンペーンから自動的にそのタグが削除されます。

リクエスト例 (Request Example)

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f)

              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f)

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

レスポンス例 (Response Example)

Response-Success

HttpStatus: 200

{ "count": 2 }

              
              {
    "count": 2
}

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

Response-Error

HttpStatus: 401

{ "code": 32606, "message": "tag_id cannot be empty" }

              
              {
    "code": 32606,
    "message": "tag_id cannot be empty"
}

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

キャンペーンへのタグ追加

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add

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

HTTP リクエストメソッド

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

リクエストヘッダー (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

ボディパラメータ (Body Parameters)

Parameter	Type	Required	Description
campaign_ids	array[string]	*	キャンペーン ID のリスト。1 回のリクエストで最大 200 個まで。

注意点：

各キャンペーンに追加できるタグは最大 20 個までです。

リクエスト例 (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{ "campaign_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/campaigns/tags/61c2be010d2b4e6a3836ab1f/add](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

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

レスポンス例 (Response Example)

Response-Success

HttpStatus: 200

{ "total": 3 }

              
              {
    "total": 3
}

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

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }

              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}

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

キャンペーンからのタグ削除

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove

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

HTTP リクエストメソッド

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

リクエストヘッダー (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

ボディパラメータ (Body Parameters)

Parameter	Type	Required	Description
campaign_ids	array[string]	*	キャンペーン ID のリスト。1 回のリクエストで最大 200 個まで。

リクエスト例 (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{ "campaign_ids": [ "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/campaigns/tags/616683a13a7b531b0336108d/remove](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

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

レスポンス例 (Response Example)

Response-Success

HttpStatus: 200

{ "total": 3 }

              
              {
    "total": 3
}

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

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }

              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}

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