Campanhas

Recuperar tudo

GET https://pushye.com/api/campaigns/
curl --request GET \
--url 'https://pushye.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional String A string de busca.
search_by Opcional String Qual campo você está pesquisando? Os valores permitidos são: name, title, description, url.
status Opcional String Valores permitidos: draft, scheduled, processing, sent
website_id Opcional Inteiro
datetime_field Opcional String Valores permitidos: datetime, scheduled_datetime, last_sent_datetime, last_datetime
datetime_start Opcional String Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Opcional String Filter results up to this datetime. Y-m-d H:i:s format.
order_by Opcional String Qual campo ordenar os resultados. Os valores permitidos são: campaign_id, datetime, last_datetime, scheduled_datetime, last_sent_datetime, name, title, total_push_notifications, total_sent_push_notifications, total_displayed_push_notifications, total_clicked_push_notifications, total_closed_push_notifications.
order_type Opcional String A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
page Opcional Inteiro O número da página de onde você deseja os resultados. O padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10, 25, 50, 100, 250, 500, 1000. O padrão é 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "website_id": 1,
            "rss_automation_id": 1,
            "recurring_campaign_id": 1,
            "name": "Example",
            "title": "Example",
            "description": "Example",
            "url": "https://example.com/",
            "image_url": "https://example.com/",
            "segment": "Example",
            "settings": [],
            "subscribers_ids": [],
            "sent_subscribers_ids": [],
            "total_push_notifications": 1,
            "total_sent_push_notifications": 1,
            "total_displayed_push_notifications": 1,
            "total_clicked_push_notifications": 1,
            "total_closed_push_notifications": 1,
            "status": 1,
            "scheduled_datetime": "2026-09-14 18:06:17",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-09-14 18:06:17"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://pushye.com/api/campaigns?page=1",
        "last": "https://pushye.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://pushye.com/api/campaigns?page=1"
    }
}

Recuperar um

GET https://pushye.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://pushye.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "rss_automation_id": 1,
        "recurring_campaign_id": 1,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "url": "https://example.com/",
        "image_url": "https://example.com/",
        "segment": "Example",
        "settings": [],
        "subscribers_ids": [],
        "sent_subscribers_ids": [],
        "total_push_notifications": 1,
        "total_sent_push_notifications": 1,
        "total_displayed_push_notifications": 1,
        "total_clicked_push_notifications": 1,
        "total_closed_push_notifications": 1,
        "status": 1,
        "scheduled_datetime": "2026-09-14 18:06:17",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-14 18:06:17"
    }
}

Criar

POST https://pushye.com/api/campaigns
Parâmetros Detalhes Descrição
website_id Requerido Inteiro -
name Requerido String -
title Requerido String -
description Requerido String -
url Opcional String -
image Opcional Arquivo -
button_title_1 Opcional String -
button_url_1 Opcional String -
button_title_2 Opcional String -
button_url_2 Opcional String -
is_scheduled Opcional Boolean -
scheduled_datetime Opcional String -
is_silent Opcional Boolean -
is_auto_hide Opcional Boolean -
ttl Opcional String Valores permitidos: 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
segment Opcional String Valores permitidos: all, custom, filter, INT segment_id
subscribers_ids Opcional String Disponível quando: segment = custom
filters_custom_parameter_key[index] Opcional String Disponível quando: segment = filter
filters_custom_parameter_condition[index] Opcional String Valores permitidos: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponível quando: segment = filter
filters_custom_parameter_value[index] Opcional String Disponível quando: segment = filter
filters_datetime_condition Opcional String Disponível quando: segment = filter within_last, older_than
filters_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_datetime_condition Opcional String Disponível quando: segment = filter within_last, older_than
filters_last_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_seen_online_datetime_condition Opcional String Disponível quando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_sent_datetime_condition Opcional String Disponível quando: segment = filter within_last, older_than
filters_last_sent_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_subscribed_on_url Opcional String Disponível quando: segment = filter
filters_cities Opcional String Disponível quando: segment = filter
filters_countries[] Opcional String Disponível quando: segment = filter
filters_continents[] Opcional String Disponível quando: segment = filter
filters_device_type[] Opcional String Disponível quando: segment = filter
filters_languages[] Opcional String Disponível quando: segment = filter
filters_operating_systems[] Opcional String Disponível quando: segment = filter
filters_browsers[] Opcional String Disponível quando: segment = filter
utm_source Opcional String -
utm_medium Opcional String -
utm_campaign Opcional String -
save Opcional Boolean Salvar rascunho
send Opcional Boolean Enviar campanha
filters_countries Opcional Array -
filters_continents Opcional Array -
filters_device_type Opcional Array -
filters_languages Opcional Array -
filters_operating_systems Opcional Array -
filters_browsers Opcional Array -
urgency Opcional Inteiro -
curl --request POST \
--url 'https://pushye.com/api/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' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "rss_automation_id": null,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "url": "https://example.com/",
        "image_url": "https://example.com/",
        "segment": "Example",
        "settings": {},
        "subscribers_ids": [],
        "sent_subscribers_ids": [],
        "total_push_notifications": 1,
        "total_sent_push_notifications": 1,
        "total_displayed_push_notifications": 1,
        "total_clicked_push_notifications": 1,
        "total_closed_push_notifications": 1,
        "status": 1,
        "scheduled_datetime": "2026-09-14 18:06:17",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-14 18:06:17"
    }
}

Atualizar

POST https://pushye.com/api/campaigns/{campaign_id}
Parâmetros Detalhes Descrição
website_id Opcional Inteiro -
name Opcional String -
title Opcional String -
description Opcional String -
url Opcional String -
image Opcional Arquivo -
button_title_1 Opcional String -
button_url_1 Opcional String -
button_title_2 Opcional String -
button_url_2 Opcional String -
is_scheduled Opcional Boolean -
scheduled_datetime Opcional String -
is_silent Opcional Boolean -
is_auto_hide Opcional Boolean -
ttl Opcional String Valores permitidos: 0, 900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 432000, 604800, 1209600, 2419200
segment Opcional String Valores permitidos: all, custom, filter, INT segment_id
subscribers_ids Opcional String Disponível quando: segment = custom
filters_custom_parameter_key[index] Opcional String Disponível quando: segment = filter
filters_custom_parameter_condition[index] Opcional String Valores permitidos: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Disponível quando: segment = filter
filters_custom_parameter_value[index] Opcional String Disponível quando: segment = filter
filters_datetime_condition Opcional String Disponível quando: segment = filter within_last, older_than
filters_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_datetime_condition Opcional String Disponível quando: segment = filter within_last, older_than
filters_last_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_seen_online_datetime_condition Opcional String Disponível quando: segment = filter within_last, older_than
filters_last_seen_online_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_last_sent_datetime_condition Opcional String Disponível quando: segment = filter within_last, older_than
filters_last_sent_datetime_value Opcional Inteiro Disponível quando: segment = filter dias
filters_subscribed_on_url Opcional String Disponível quando: segment = filter
filters_cities Opcional String Disponível quando: segment = filter
filters_countries[] Opcional String Disponível quando: segment = filter
filters_continents[] Opcional String Disponível quando: segment = filter
filters_device_type[] Opcional String Disponível quando: segment = filter
filters_languages[] Opcional String Disponível quando: segment = filter
filters_operating_systems[] Opcional String Disponível quando: segment = filter
filters_browsers[] Opcional String Disponível quando: segment = filter
utm_source Opcional String -
utm_medium Opcional String -
utm_campaign Opcional String -
save Opcional Boolean Salvar rascunho
send Opcional Boolean Enviar campanha
filters_countries Opcional Array -
filters_continents Opcional Array -
filters_device_type Opcional Array -
filters_languages Opcional Array -
filters_operating_systems Opcional Array -
filters_browsers Opcional Array -
urgency Opcional Inteiro -
curl --request POST \
--url 'https://pushye.com/api/campaigns/{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' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "rss_automation_id": null,
        "recurring_campaign_id": null,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "url": "https://example.com/",
        "image_url": "https://example.com/",
        "segment": "Example",
        "settings": {},
        "subscribers_ids": [],
        "sent_subscribers_ids": [],
        "total_push_notifications": 1,
        "total_sent_push_notifications": 1,
        "total_displayed_push_notifications": 1,
        "total_clicked_push_notifications": 1,
        "total_closed_push_notifications": 1,
        "status": 1,
        "scheduled_datetime": "2026-09-14 18:06:17",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-09-14 18:06:17"
    }
}

Excluir

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