Recurring campaigns

Recuperar todo

GET https://pushye.com/api/recurring-campaigns/
curl --request GET \
--url 'https://pushye.com/api/recurring-campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parámetros Detalles Descripción
page Opcional Entero El número de página del que deseas obtener resultados. Por defecto es 1.
results_per_page Opcional Entero Cuántos resultados deseas por página. Los valores permitidos son: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Por defecto es 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 14:50:45" } ], "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" } }

Recuperar 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 14:50:45" } }

Crear

POST https://pushye.com/api/recurring-campaigns
Parámetros Detalles Descripción
website_id Requerido Entero -
name Requerido Cadena -
title Requerido Cadena -
description Requerido Cadena -
url Opcional Cadena -
image Opcional Archivo -
button_title_1 Opcional Cadena -
button_url_1 Opcional Cadena -
button_title_2 Opcional Cadena -
button_url_2 Opcional Cadena -
is_silent Opcional Boolean -
is_auto_hide Opcional Boolean -
ttl Opcional Cadena Valores permitidos: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source Opcional Cadena -
utm_medium Opcional Cadena -
utm_campaign Opcional Cadena -
frequency Opcional Cadena Valores permitidos: daily , weekly , monthly
week_days Opcional Cadena Valores permitidos: 1 , 2 , 3 , 4 , 5 , 6 , 7 Disponible cuando: frequency = weekly
month_days Opcional Cadena Valores permitidos: 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 Disponible cuando: frequency = monthly
time Opcional Cadena HH:II
is_enabled Opcional 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 } }

Actualizar

POST https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}
Parámetros Detalles Descripción
website_id Opcional Entero -
name Opcional Cadena -
title Opcional Cadena -
description Opcional Cadena -
url Opcional Cadena -
image Opcional Archivo -
button_title_1 Opcional Cadena -
button_url_1 Opcional Cadena -
button_title_2 Opcional Cadena -
button_url_2 Opcional Cadena -
is_silent Opcional Boolean -
is_auto_hide Opcional Boolean -
ttl Opcional Cadena Valores permitidos: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source Opcional Cadena -
utm_medium Opcional Cadena -
utm_campaign Opcional Cadena -
frequency Opcional Cadena Valores permitidos: daily , weekly , monthly
week_days Opcional Cadena Valores permitidos: 1 , 2 , 3 , 4 , 5 , 6 , 7 Disponible cuando: frequency = weekly
month_days Opcional Cadena Valores permitidos: 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 Disponible cuando: frequency = monthly
time Opcional Cadena HH:II
is_enabled Opcional 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 } }

Eliminar

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