Delete Campaign
Remove an SMS campaign from your account. This is a soft delete — the campaign disappears from the API and the dashboard, but delivery history and analytics for sent campaigns are preserved server-side.
Endpoint
DELETE /sms/campaigns/:id
Returns: 200 OK
Prerequisites
Soft Delete
Deleting a campaign removes it from your account but preserves analytics and delivery history for campaigns that have already been sent. Deleted campaigns cannot be restored via the API.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The campaign ID. |
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer <your-api-key> | Yes |
Response
{
"message": "Campaign deleted"
}
Examples
- cURL
- JavaScript
- Python
- C#
- PHP
curl -X DELETE "https://api.arsel.sa/v1/sms/campaigns/0192a1b2-c3d4-7e5f-9000-abcdef123456" \
-H "Authorization: Bearer be_your_api_key"
const campaignId = "0192a1b2-c3d4-7e5f-9000-abcdef123456";
const response = await fetch(
`https://api.arsel.sa/v1/sms/campaigns/${campaignId}`,
{
method: "DELETE",
headers: { Authorization: "Bearer be_your_api_key" },
}
);
const result = await response.json();
console.log(result.message); // "Campaign deleted"
import requests
campaign_id = "0192a1b2-c3d4-7e5f-9000-abcdef123456"
response = requests.delete(
f"https://api.arsel.sa/v1/sms/campaigns/{campaign_id}",
headers={"Authorization": "Bearer be_your_api_key"},
)
result = response.json()
print(result["message"]) # "Campaign deleted"
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer be_your_api_key");
var campaignId = "0192a1b2-c3d4-7e5f-9000-abcdef123456";
var response = await client.DeleteAsync(
$"https://api.arsel.sa/v1/sms/campaigns/{campaignId}"
);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
<?php
$campaignId = "0192a1b2-c3d4-7e5f-9000-abcdef123456";
$ch = curl_init("https://api.arsel.sa/v1/sms/campaigns/{$campaignId}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer be_your_api_key"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
$response = curl_exec($ch);
echo $response;
curl_close($ch);
Error Responses
- 401 Unauthorized
- 404 Not Found
{
"status_code": 401,
"name": "unauthorized",
"message": "Invalid or missing API key"
}
{
"status_code": 404,
"name": "not_found",
"message": "Campaign not found"
}