API Documentation
Sign in

Campaigns

Retrieve all

GET https://notificatorsms.com/api/campaigns/
curl --request GET \
--url 'https://notificatorsms.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \ 
curl --request GET \
  --url 'https://notificatorsms.com/api/campaigns/' \
  --header 'Authorization: Bearer VOTRE_API_KEY'
<?php
$ch = curl_init('https://notificatorsms.com/api/campaigns/');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer VOTRE_API_KEY'],
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($result);
const res = await fetch('https://notificatorsms.com/api/campaigns/', {
    headers: { 'Authorization': 'Bearer VOTRE_API_KEY' },
});
const data = await res.json();
console.log(data);
import requests

headers = {'Authorization': 'Bearer VOTRE_API_KEY'}
r = requests.get('https://notificatorsms.com/api/campaigns/', headers=headers)
print(r.json())
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10, 25, 50, 100, 250, 500, 1000. Defaults to 25.
search Optional String The search string.
search_by Optional String What field are you searching by. Allowed values are: name, content.
status Optional String Allowed values: draft, scheduled, processing, sent
segment Optional String Filter results by segment.
rss_automation_id Optional Integer Filter results by RSS automation ID.
user_id Optional Integer Filter results by user ID.
datetime_field Optional String Allowed values: datetime, scheduled_datetime, last_sent_datetime, last_datetime
datetime_start Optional String Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Optional String Filter results up to this datetime. Y-m-d H:i:s format.
order_by Optional String What field to order the results by. Allowed values are: campaign_id, name, content, datetime, scheduled_datetime, last_sent_datetime, last_datetime, total_sent_sms, total_pending_sms, total_failed_sms.
order_type Optional String The ordering of the results. Allowed values are: ASC for ascending ordering, and DESC for descending ordering. 
{
    "data": [
        {
            "id": 1,
            "rss_automation_id": 0,
            "recurring_campaign_id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "user_id": 1,
            "name": "Example",
            "content": "Sample message",
            "segment": "all",
            "settings": {
                "is_scheduled": 0,
            },
            "contacts_ids": [
                1,2,3,4,5
            ],
            "sent_contacts_ids": [],
            "total_sent_sms": 0,
            "total_pending_sms": 1,
            "total_failed_sms": 0,
            "status": "draft",
            "scheduled_datetime": "2026-05-17 16:52:40",
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2026-05-17 16:52:40",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://notificatorsms.com/api/campaigns?page=1",
        "last": "https://notificatorsms.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://notificatorsms.com/api/campaigns?page=1"
    }
}

Retrieve one

GET https://notificatorsms.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://notificatorsms.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
curl --request GET \
  --url 'https://notificatorsms.com/api/campaigns/{campaign_id}' \
  --header 'Authorization: Bearer VOTRE_API_KEY'
<?php
$ch = curl_init('https://notificatorsms.com/api/campaigns/{campaign_id}');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer VOTRE_API_KEY'],
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($result);
const res = await fetch('https://notificatorsms.com/api/campaigns/{campaign_id}', {
    headers: { 'Authorization': 'Bearer VOTRE_API_KEY' },
});
const data = await res.json();
console.log(data);
import requests

headers = {'Authorization': 'Bearer VOTRE_API_KEY'}
r = requests.get('https://notificatorsms.com/api/campaigns/{campaign_id}', headers=headers)
print(r.json())
{
    "data": {
        "id": 1,
        "rss_automation_id": 0,
        "recurring_campaign_id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "user_id": 1,
        "name": "Example",
        "content": "Sample message",
        "segment": "all",
        "settings": {
            "is_scheduled": 0,
        },
        "contacts_ids": [
            1,2,3,4,5
        ],
        "sent_contacts_ids": [],
        "total_sent_sms": 0,
        "total_pending_sms": 1,
        "total_failed_sms": 0,
        "status": "draft",
        "scheduled_datetime": "2026-05-17 16:52:40",
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2026-05-17 16:52:40",
    }
}

Create

POST https://notificatorsms.com/api/campaigns
Parameters Details Description
name Required String -
content Required String -
device_id Required Integer -
sim_subscription_id Required Integer -
is_scheduled Optional Boolean -
scheduled_datetime Optional String -
segment Optional String Allowed values: all, bulk, custom, filter, INT segment_id
phone_numbers Optional String Available when: segment = bulk
contacts_ids Optional String Available when: segment = custom
filters_custom_parameter_key[index] Optional String Available when: segment = filter
filters_custom_parameter_condition[index] Optional String Allowed values: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Available when: segment = filter
filters_custom_parameter_value[index] Optional String Available when: segment = filter
filters_countries[] Optional String Available when: segment = filter
filters_continents[] Optional String Available when: segment = filter
save Optional Boolean Save draft
send Optional Boolean Send campaign
curl --request POST \
--url 'https://notificatorsms.com/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
curl --request POST \
  --url 'https://notificatorsms.com/api/campaigns' \
  --header 'Authorization: Bearer VOTRE_API_KEY' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=Ma Campagne' \
  --form 'segment_id=1' \
  --form 'device_id=1'
<?php
$ch = curl_init('https://notificatorsms.com/api/campaigns');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => [
        'name' => 'Ma Campagne',
        'segment_id' => '1',
        'device_id' => '1',
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer VOTRE_API_KEY'],
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($result);
const form = new FormData();
form.append('name', 'Ma Campagne');
form.append('segment_id', '1');
form.append('device_id', '1');

const res = await fetch('https://notificatorsms.com/api/campaigns', {
    method: 'POST',
    headers: { 'Authorization': 'Bearer VOTRE_API_KEY' },
    body: form,
});
const data = await res.json();
console.log(data);
import requests

headers = {'Authorization': 'Bearer VOTRE_API_KEY'}
payload = {
    'name': 'Ma Campagne',
    'segment_id': '1',
    'device_id': '1',
}
r = requests.post('https://notificatorsms.com/api/campaigns', data=payload, headers=headers)
print(r.json())
{
    "data": {
        "id": 1
    }
}

Update

POST https://notificatorsms.com/api/campaigns/{campaign_id}
Parameters Details Description
name Optional String -
content Optional String -
device_id Optional Integer -
sim_subscription_id Optional Integer -
is_scheduled Optional Boolean -
scheduled_datetime Optional String -
segment Optional String Allowed values: all, bulk, custom, filter, INT segment_id
phone_numbers Optional String Available when: segment = bulk
contacts_ids Optional String Available when: segment = custom
filters_custom_parameter_key[index] Optional String Available when: segment = filter
filters_custom_parameter_condition[index] Optional String Allowed values: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than Available when: segment = filter
filters_custom_parameter_value[index] Optional String Available when: segment = filter
filters_custom_parameter_value[index] Optional String Available when: segment = filter
filters_countries[] Optional String Available when: segment = filter
filters_continents[] Optional String Available when: segment = filter
save Optional Boolean Save draft
send Optional Boolean Send campaign
curl --request POST \
--url 'https://notificatorsms.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
curl --request POST \
  --url 'https://notificatorsms.com/api/campaigns/{campaign_id}' \
  --header 'Authorization: Bearer VOTRE_API_KEY' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=Ma Campagne'
<?php
$ch = curl_init('https://notificatorsms.com/api/campaigns/{campaign_id}');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => [
        'name' => 'Ma Campagne',
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer VOTRE_API_KEY'],
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($result);
const form = new FormData();
form.append('name', 'Ma Campagne');

const res = await fetch('https://notificatorsms.com/api/campaigns/{campaign_id}', {
    method: 'POST',
    headers: { 'Authorization': 'Bearer VOTRE_API_KEY' },
    body: form,
});
const data = await res.json();
console.log(data);
import requests

headers = {'Authorization': 'Bearer VOTRE_API_KEY'}
payload = {
    'name': 'Ma Campagne',
}
r = requests.post('https://notificatorsms.com/api/campaigns/{campaign_id}', data=payload, headers=headers)
print(r.json())
{
    "data": {
        "id": 1
    }
}

Delete

DELETE https://notificatorsms.com/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://notificatorsms.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
curl --request DELETE \
  --url 'https://notificatorsms.com/api/campaigns/{campaign_id}' \
  --header 'Authorization: Bearer VOTRE_API_KEY'
<?php
$ch = curl_init('https://notificatorsms.com/api/campaigns/{campaign_id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer VOTRE_API_KEY'],
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($result);
const res = await fetch('https://notificatorsms.com/api/campaigns/{campaign_id}', {
    method: 'DELETE',
    headers: { 'Authorization': 'Bearer VOTRE_API_KEY' },
});
const data = await res.json();
console.log(data);
import requests

headers = {'Authorization': 'Bearer VOTRE_API_KEY'}
r = requests.delete('https://notificatorsms.com/api/campaigns/{campaign_id}', headers=headers)
print(r.json())
Copyright © 2026 Notificatorsms.