Recurring campaigns

Hämta alla

GET https://pushye.com/api/recurring-campaigns/
curl --request GET \
--url 'https://pushye.com/api/recurring-campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parametrar Detaljer Beskrivning
page Valfritt Heltal Sidanummeret som du vill ha resultat från. Standardinställning är 1.
results_per_page Valfritt Heltal Hur många resultat vill du ha per sida. Tillåtna värden är: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Standardvärde är 25.
{ "data": [ { "id": 1, "user_id": 1, "website_id": 1, "name": "API Sample", "title": "Sample message", "description": "This is coming from the API.", "url": "https://example.com", "image_url": null, "settings": { "ttl": 2419200, "urgency": "normal", "is_silent": 0, "is_auto_hide": 0, "button_title_1": "", "button_url_1": "", "button_title_2": "", "button_url_2": "", "frequency": "daily, "time": 10:25, }, "segment": "all", "is_enabled": true, "total_sent_push_notifications": 0, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "last_sent_datetime": null, "last_datetime": null, "datetime": "2025-02-05 12:52:07" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://pushye.com/api/recurring-campaigns?&page=1", "last": "https://pushye.com/api/recurring-campaigns?&page=1", "next": null, "prev": null, "self": "https://pushye.com/api/recurring-campaigns?&page=1" } }

Hämta en

GET https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}
curl --request GET \
--url 'https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "user_id": 1, "website_id": 1, "name": "API Sample", "title": "Sample message", "description": "This is coming from the API.", "url": "https://example.com", "image_url": null, "settings": { "ttl": 2419200, "urgency": "normal", "is_silent": 0, "is_auto_hide": 0, "button_title_1": "", "button_url_1": "", "button_title_2": "", "button_url_2": "", "frequency": "daily, "time": 10:25, }, "segment": "all", "is_enabled": true, "total_sent_push_notifications": 0, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "last_sent_datetime": null, "last_datetime": null, "datetime": "2025-02-05 12:52:07" } }

Skapa

POST https://pushye.com/api/recurring-campaigns
Parametrar Detaljer Beskrivning
website_id Obligatoriskt Heltal -
name Obligatoriskt Sträng -
title Obligatoriskt Sträng -
description Obligatoriskt Sträng -
url Valfritt Sträng -
image Valfritt Fil -
button_title_1 Valfritt Sträng -
button_url_1 Valfritt Sträng -
button_title_2 Valfritt Sträng -
button_url_2 Valfritt Sträng -
is_silent Valfritt Boolean -
is_auto_hide Valfritt Boolean -
ttl Valfritt Sträng Tillåtna värden: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source Valfritt Sträng -
utm_medium Valfritt Sträng -
utm_campaign Valfritt Sträng -
frequency Valfritt Sträng Tillåtna värden: daily , weekly , monthly
week_days Valfritt Sträng Tillåtna värden: 1 , 2 , 3 , 4 , 5 , 6 , 7 Tillgänglig när: frequency = weekly
month_days Valfritt Sträng Tillåtna värden: 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 Tillgänglig när: frequency = monthly
time Valfritt Sträng HH:II
is_enabled Valfritt Boolean -
curl --request POST \
--url 'https://pushye.com/api/recurring-campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
--form 'frequency=daily' \
--form 'time=12:15' \
{ "data": { "id": 1 } }

Uppdatera

POST https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}
Parametrar Detaljer Beskrivning
website_id Valfritt Heltal -
name Valfritt Sträng -
title Valfritt Sträng -
description Valfritt Sträng -
url Valfritt Sträng -
image Valfritt Fil -
button_title_1 Valfritt Sträng -
button_url_1 Valfritt Sträng -
button_title_2 Valfritt Sträng -
button_url_2 Valfritt Sträng -
is_silent Valfritt Boolean -
is_auto_hide Valfritt Boolean -
ttl Valfritt Sträng Tillåtna värden: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source Valfritt Sträng -
utm_medium Valfritt Sträng -
utm_campaign Valfritt Sträng -
frequency Valfritt Sträng Tillåtna värden: daily , weekly , monthly
week_days Valfritt Sträng Tillåtna värden: 1 , 2 , 3 , 4 , 5 , 6 , 7 Tillgänglig när: frequency = weekly
month_days Valfritt Sträng Tillåtna värden: 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 Tillgänglig när: frequency = monthly
time Valfritt Sträng HH:II
is_enabled Valfritt Boolean -
curl --request POST \
--url 'https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{ "data": { "id": 1 } }

Ta bort

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