活动

检索所有

GET https://notifyc.com/api/campaigns/
curl --request GET \
--url 'https://notifyc.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
参数 细节 描述
search 可选的 字符串 搜索字符串。
search_by 可选的 字符串 您正在按哪个字段搜索。允许的值为：name , domain。
is_enabled 可选的 布尔值
domain_id 可选的 整数
order_by 可选的 字符串 按哪个字段排序结果。允许的值有：campaign_id , datetime , last_datetime , name , domain。
order_type 可选的 字符串 结果的排序。允许的值为：ASC 表示升序排序，DESC 表示降序排序。
page 可选的 整数 您想要结果的页码。默认为 1。
results_per_page 可选的 整数 每页您想要多少个结果。允许的值是：10 , 25 , 50 , 100 , 250 , 500 , 1000。默认为25。 
{
    "data": [
        {
            "id": 1,
            "pixel_key": "1234567890abcdef",
            "name": "Example",
            "domain": "example.com",
            "branding": {
                "name": "",
                "url": ""
            },
            "email_reports_is_enabled": true,
            "email_reports_last_datetime": "2019-05-22 23:40:17",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-04-21 14:00:30",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://notifyc.com/api/campaigns?page=1",
        "last": "https://notifyc.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://notifyc.com/api/campaigns?page=1"
    }
}

检索一个

GET https://notifyc.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://notifyc.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "pixel_key": "1234567890abcdef",
        "name": "Example",
        "domain": "example.com",
        "branding": {
            "name": "",
            "url": ""
        },
        "email_reports_is_enabled": true,
        "email_reports_last_datetime": "2019-05-22 23:40:17",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-04-21 14:00:30",
    }
}

创建

POST https://notifyc.com/api/campaigns
参数 细节 描述
domain_id 可选的 整数 -
name 必需 字符串 -
domain 必需 字符串 -
branding_name 可选的 字符串 -
branding_url 可选的 字符串 -
email_reports 可选的 数组 通知处理程序 ID
is_enabled 可选的 布尔值 -
curl --request POST \
--url 'https://notifyc.com/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{
    "data": {
        "id": 1
    }
}

更新

POST https://notifyc.com/api/campaigns/{campaign_id}
参数 细节 描述
domain_id 可选的 整数 -
name 可选的 字符串 -
domain 可选的 字符串 -
branding_name 可选的 字符串 -
branding_url 可选的 字符串 -
email_reports 可选的 数组 通知处理程序 ID
is_enabled 可选的 布尔值 -
curl --request POST \
--url 'https://notifyc.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1
    }
}

删除

DELETE https://notifyc.com/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://notifyc.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \