Campagne

Recupera tutto

GET https://notifyc.com/api/campaigns/
curl --request GET \
--url 'https://notifyc.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parametri Dettagli Descrizione
search Facoltativo String La stringa di ricerca.
search_by Facoltativo String Quale campo stai cercando. I valori consentiti sono: name , domain.
is_enabled Facoltativo Boolean
domain_id Facoltativo Intero
order_by Facoltativo String In quale campo ordinare i risultati. I valori consentiti sono: campaign_id , datetime , last_datetime , name , domain.
order_type Facoltativo String L'ordinamento dei risultati. I valori consentiti sono: ASC per ordinamento crescente e DESC per ordinamento decrescente.
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,
            "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": "2026-04-21 13:59:28",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://notifyc.com/api/campaigns?page=1",
        "last": "https://notifyc.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://notifyc.com/api/campaigns?page=1"
    }
}

Recupera uno

GET https://notifyc.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://notifyc.com/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": "2026-04-21 13:59:28",
    }
}

Crea

POST https://notifyc.com/api/campaigns
Parametri Dettagli Descrizione
domain_id Facoltativo Intero -
name Richiesto String -
domain Richiesto String -
branding_name Facoltativo String -
branding_url Facoltativo String -
email_reports Facoltativo Array ID del gestore delle notifiche
is_enabled Facoltativo Boolean -
curl --request POST \
--url 'https://notifyc.com/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{
    "data": {
        "id": 1
    }
}

Aggiornare

POST https://notifyc.com/api/campaigns/{campaign_id}
Parametri Dettagli Descrizione
domain_id Facoltativo Intero -
name Facoltativo String -
domain Facoltativo String -
branding_name Facoltativo String -
branding_url Facoltativo String -
email_reports Facoltativo Array ID del gestore delle notifiche
is_enabled Facoltativo Boolean -
curl --request POST \
--url 'https://notifyc.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1
    }
}

Elimina

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