Recurring campaigns

Recupera tutto

GET https://pushye.com/api/recurring-campaigns/
curl --request GET \
--url 'https://pushye.com/api/recurring-campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parametri Dettagli Descrizione
page Facoltativo Intero Il numero di pagina da cui desideri i risultati. Predefinito a 1.
results_per_page Facoltativo Intero Quanti risultati vuoi per pagina. I valori consentiti sono: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Predefinito è 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 15:50:20" } ], "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" } }

Recupera uno

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 15:50:20" } }

Crea

POST https://pushye.com/api/recurring-campaigns
Parametri Dettagli Descrizione
website_id Richiesto Intero -
name Richiesto String -
title Richiesto String -
description Richiesto String -
url Facoltativo String -
image Facoltativo File -
button_title_1 Facoltativo String -
button_url_1 Facoltativo String -
button_title_2 Facoltativo String -
button_url_2 Facoltativo String -
is_silent Facoltativo Boolean -
is_auto_hide Facoltativo Boolean -
ttl Facoltativo String Valori consentiti: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source Facoltativo String -
utm_medium Facoltativo String -
utm_campaign Facoltativo String -
frequency Facoltativo String Valori consentiti: daily , weekly , monthly
week_days Facoltativo String Valori consentiti: 1 , 2 , 3 , 4 , 5 , 6 , 7 Disponibile quando: frequency = weekly
month_days Facoltativo String Valori consentiti: 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 Disponibile quando: frequency = monthly
time Facoltativo String HH:II
is_enabled Facoltativo 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 } }

Aggiornare

POST https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}
Parametri Dettagli Descrizione
website_id Facoltativo Intero -
name Facoltativo String -
title Facoltativo String -
description Facoltativo String -
url Facoltativo String -
image Facoltativo File -
button_title_1 Facoltativo String -
button_url_1 Facoltativo String -
button_title_2 Facoltativo String -
button_url_2 Facoltativo String -
is_silent Facoltativo Boolean -
is_auto_hide Facoltativo Boolean -
ttl Facoltativo String Valori consentiti: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source Facoltativo String -
utm_medium Facoltativo String -
utm_campaign Facoltativo String -
frequency Facoltativo String Valori consentiti: daily , weekly , monthly
week_days Facoltativo String Valori consentiti: 1 , 2 , 3 , 4 , 5 , 6 , 7 Disponibile quando: frequency = weekly
month_days Facoltativo String Valori consentiti: 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 Disponibile quando: frequency = monthly
time Facoltativo String HH:II
is_enabled Facoltativo 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 } }

Elimina

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}' \