任务标签管理

调用地址

数据中心	URL
新加坡	https://email.api.engagelab.cc
土耳其	https://emailapi-tr.engagelab.com

当使用 REST API 时，需要将选定的 base URL 与具体 API 的路径结合起来获得完整的调用地址。

POST/v1/marketing/campaigns/tags

创建任务标签

URL

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

此代码块在浮窗中显示

请求 Headers

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

Body 参数

Parameter	Type	Required	Description
tag_names	array[string]	true	标签名称，最长64个字符，仅由 a-z,A-z,0-9,_, 中文汉字等组成

说明：

1、每个Organization最多可创建100个标签。

2、标签名称不可重复。

请求示例

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 --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 --data '{
    "tag_names": ["双十一促销", "新用户"]
}'

此代码块在浮窗中显示

响应示例

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

此代码块在浮窗中显示

HTTP 请求方式

GET

GET

此代码块在浮窗中显示

Content-Type

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

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

此代码块在浮窗中显示

请求 Headers

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

Query 参数

Parameter	Type	Required	Description
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/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

此代码块在浮窗中显示

响应说明

Parameter	Type	Description
tag_id	string	标签ID
tag_name	string	标签名称
create_time	string	创建时间
update_time	string	更新时间

响应示例

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/{tag_id}

              
              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

此代码块在浮窗中显示

请求 Headers

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

Path 参数

Parameter	Type	Required	Description
tag_id	string	true	标签ID

Body 参数

Parameter	Type	Required	Description
tag_name	string	true	标签名称，仅支持中文、英文大小写、数字、下划线，长度1-64

请求示例

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 --data '{ "tag_name": "618促销" }'

              
              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 --data '{
    "tag_name": "618促销"
}'

此代码块在浮窗中显示

响应示例

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

此代码块在浮窗中显示

HTTP 请求方式

DELETE

              
              DELETE

此代码块在浮窗中显示

Content-Type

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

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

此代码块在浮窗中显示

请求 Headers

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

说明：

1、删除标签后，关联的campaign将自动移除该标签。

请求示例

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i 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

此代码块在浮窗中显示

响应示例

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/{tag_id}/add

              
              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

此代码块在浮窗中显示

请求 Headers

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

Body 参数

Parameter	Type	Required	Description
campaign_ids	array[string]	*	任务ID列表，单次最多200个

说明：

1、每个campaign最多可添加20个tag。

请求示例

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 --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 --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

此代码块在浮窗中显示

响应示例

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/{tag_id}/remove

              
              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

此代码块在浮窗中显示

请求 Headers

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

Body 参数

Parameter	Type	Required	Description
campaign_ids	array[string]	*	任务ID列表，单次最多200个

请求示例

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 --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 --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

此代码块在浮窗中显示

响应示例

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"
}

此代码块在浮窗中显示