Campanhas

Listar todos

GET https://pushes.com.br/api/campaigns/
curl --request GET \
--url 'https://pushes.com.br/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
page Opcional Número inteiro Número da página desejada. Padrão: 1.
results_per_page Opcional Número inteiro Quantidade de resultados por página. Valores permitidos: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Padrão: 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-08-14 22:36:32" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://pushes.com.br/api/campaigns?&page=1", "last": "https://pushes.com.br/api/campaigns?&page=1", "next": null, "prev": null, "self": "https://pushes.com.br/api/campaigns?&page=1" } }

Listar um

GET https://pushes.com.br/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://pushes.com.br/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-08-14 22:36:32" } }

Criar

POST https://pushes.com.br/api/campaigns
Parâmetros Detalhes Descrição
domain_id Opcional Número inteiro -
name Obrigatório Texto -
domain Obrigatório Texto -
branding_name Opcional Texto -
branding_url Opcional Texto -
email_reports Opcional Lista IDs dos gerenciadores de notificação
is_enabled Opcional Booleano -
curl --request POST \
--url 'https://pushes.com.br/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{ "data": { "id": 1 } }

Atualizar

POST https://pushes.com.br/api/campaigns/{campaign_id}
Parâmetros Detalhes Descrição
domain_id Opcional Número inteiro -
name Opcional Texto -
domain Opcional Texto -
branding_name Opcional Texto -
branding_url Opcional Texto -
email_reports Opcional Lista IDs dos gerenciadores de notificação
is_enabled Opcional Booleano -
curl --request POST \
--url 'https://pushes.com.br/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{ "data": { "id": 1 } }

Excluir

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