Campaigns - Send
Send a campaign to a list of phone numbers, now or at a scheduled time. Up to 1000 contacts per request; duplicates are removed. The send is queued and processed in the background. Rate limit: 10 requests per second.
POST
/
api
/
campaigns
/
send
Campaigns - Send
curl --request POST \
--url https://getsimio.app/api/campaigns/send \
--header 'Content-Type: application/json' \
--header 'simio-api-key: <api-key>' \
--data '
{
"campaign_id": 123,
"contacts": [
"33612345678",
"33698765432"
],
"is_forced": false,
"scheduled_at": "2025-09-01T09:00:00Z"
}
'import requests
url = "https://getsimio.app/api/campaigns/send"
payload = {
"campaign_id": 123,
"contacts": ["33612345678", "33698765432"],
"is_forced": False,
"scheduled_at": "2025-09-01T09:00:00Z"
}
headers = {
"simio-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'simio-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaign_id: 123,
contacts: ['33612345678', '33698765432'],
is_forced: false,
scheduled_at: '2025-09-01T09:00:00Z'
})
};
fetch('https://getsimio.app/api/campaigns/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://getsimio.app/api/campaigns/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'campaign_id' => 123,
'contacts' => [
'33612345678',
'33698765432'
],
'is_forced' => false,
'scheduled_at' => '2025-09-01T09:00:00Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"simio-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://getsimio.app/api/campaigns/send"
payload := strings.NewReader("{\n \"campaign_id\": 123,\n \"contacts\": [\n \"33612345678\",\n \"33698765432\"\n ],\n \"is_forced\": false,\n \"scheduled_at\": \"2025-09-01T09:00:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("simio-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://getsimio.app/api/campaigns/send")
.header("simio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_id\": 123,\n \"contacts\": [\n \"33612345678\",\n \"33698765432\"\n ],\n \"is_forced\": false,\n \"scheduled_at\": \"2025-09-01T09:00:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://getsimio.app/api/campaigns/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["simio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign_id\": 123,\n \"contacts\": [\n \"33612345678\",\n \"33698765432\"\n ],\n \"is_forced\": false,\n \"scheduled_at\": \"2025-09-01T09:00:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"batch_id": "1759842000000",
"contacts": 2,
"status": "accepted"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"error": "Rate limit exceeded: 10 per 1 second"
}Authorizations
Company API key, created in Settings > Integrations & developers > Credentials.
Body
application/json
ID of the campaign to send.
Example:
123
Recipient phone numbers in E.164 format (up to 1000 per request; duplicates are removed).
Pattern:
^\+?[1-9]\d{6,14}$Example:
["33612345678", "33698765432"]
Bypass the account's delivery-hours and opt-out checks.
Example:
false
ISO 8601 datetime to schedule the send for; omit to send immediately.
Maximum string length:
64Example:
"2025-09-01T09:00:00Z"
Response
Successful Response
⌘I
Campaigns - Send
curl --request POST \
--url https://getsimio.app/api/campaigns/send \
--header 'Content-Type: application/json' \
--header 'simio-api-key: <api-key>' \
--data '
{
"campaign_id": 123,
"contacts": [
"33612345678",
"33698765432"
],
"is_forced": false,
"scheduled_at": "2025-09-01T09:00:00Z"
}
'import requests
url = "https://getsimio.app/api/campaigns/send"
payload = {
"campaign_id": 123,
"contacts": ["33612345678", "33698765432"],
"is_forced": False,
"scheduled_at": "2025-09-01T09:00:00Z"
}
headers = {
"simio-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'simio-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaign_id: 123,
contacts: ['33612345678', '33698765432'],
is_forced: false,
scheduled_at: '2025-09-01T09:00:00Z'
})
};
fetch('https://getsimio.app/api/campaigns/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://getsimio.app/api/campaigns/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'campaign_id' => 123,
'contacts' => [
'33612345678',
'33698765432'
],
'is_forced' => false,
'scheduled_at' => '2025-09-01T09:00:00Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"simio-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://getsimio.app/api/campaigns/send"
payload := strings.NewReader("{\n \"campaign_id\": 123,\n \"contacts\": [\n \"33612345678\",\n \"33698765432\"\n ],\n \"is_forced\": false,\n \"scheduled_at\": \"2025-09-01T09:00:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("simio-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://getsimio.app/api/campaigns/send")
.header("simio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_id\": 123,\n \"contacts\": [\n \"33612345678\",\n \"33698765432\"\n ],\n \"is_forced\": false,\n \"scheduled_at\": \"2025-09-01T09:00:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://getsimio.app/api/campaigns/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["simio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign_id\": 123,\n \"contacts\": [\n \"33612345678\",\n \"33698765432\"\n ],\n \"is_forced\": false,\n \"scheduled_at\": \"2025-09-01T09:00:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"batch_id": "1759842000000",
"contacts": 2,
"status": "accepted"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"error": "Rate limit exceeded: 10 per 1 second"
}