کمپین ها

همه را بازیابی کنید

GET https://notifer.ir/api/campaigns/
curl --request GET \
--url 'https://notifer.ir/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
پارامترها جزئیات توضیحات
page اختیاری Integer شماره صفحه ای که می خواهید از آن نتیجه بگیرید. پیش‌فرض 1 است.
results_per_page اختیاری Integer در هر صفحه چند نتیجه می خواهید. مقادیر مجاز عبارتند از: 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": "2025-03-13 00:13:12" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://notifer.ir/api/campaigns?&page=1", "last": "https://notifer.ir/api/campaigns?&page=1", "next": null, "prev": null, "self": "https://notifer.ir/api/campaigns?&page=1" } }

یکی را بازیابی کنید

GET https://notifer.ir/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://notifer.ir/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": "2025-03-13 00:13:12" } }

ایجاد

POST https://notifer.ir/api/campaigns
پارامترها جزئیات توضیحات
domain_id اختیاری Integer -
name اجباری String -
domain اجباری String -
branding_name اختیاری String -
branding_url اختیاری String -
email_reports اختیاری Array Notification handler ids
is_enabled اختیاری Boolean -
curl --request POST \
--url 'https://notifer.ir/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://notifer.ir/api/campaigns/{campaign_id}
پارامترها جزئیات توضیحات
domain_id اختیاری Integer -
name اختیاری String -
domain اختیاری String -
branding_name اختیاری String -
branding_url اختیاری String -
email_reports اختیاری Array Notification handler ids
is_enabled اختیاری Boolean -
curl --request POST \
--url 'https://notifer.ir/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{ "data": { "id": 1 } }

حذف

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