Remove Contact from Campaign
curl --request DELETE \
--url https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}import requests
url = "https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}"
response = requests.delete(url)
print(response.text)const options = {method: 'DELETE'};
fetch('https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}', 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://api.example.com/v1/campaigns/{id}/contacts/{contact_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"removed": true,
"campaign_id": "<string>",
"contact_id": "<string>"
}
}Campaigns
Remove Contact from Campaign
Unenroll a single contact from a campaign; already-sent emails are unaffected
DELETE
/
v1
/
campaigns
/
{id}
/
contacts
/
{contact_id}
Remove Contact from Campaign
curl --request DELETE \
--url https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}import requests
url = "https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}"
response = requests.delete(url)
print(response.text)const options = {method: 'DELETE'};
fetch('https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}', 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://api.example.com/v1/campaigns/{id}/contacts/{contact_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/campaigns/{id}/contacts/{contact_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"removed": true,
"campaign_id": "<string>",
"contact_id": "<string>"
}
}Request
Path Parameters
string
required
The campaign’s unique ID (UUID)
string
required
The contact’s unique ID (UUID)
Headers
Authorization: Bearer wbk_your_api_key_here
Requires an API key with the
campaigns:write permission. Any future scheduled sends for this contact in this campaign are cancelled; emails already dispatched are not recalled.Response
object
curl -X DELETE https://data.leadlex.com/functions/v1/api-gateway/v1/campaigns/cmp_abc123/contacts/123e4567-e89b-12d3-a456-426614174000 \
-H "Authorization: Bearer wbk_your_api_key_here"
import requests
API_KEY = "wbk_your_api_key_here"
BASE_URL = "https://data.leadlex.com/functions/v1/api-gateway"
CAMPAIGN_ID = "cmp_abc123"
CONTACT_ID = "123e4567-e89b-12d3-a456-426614174000"
response = requests.delete(
f"{BASE_URL}/v1/campaigns/{CAMPAIGN_ID}/contacts/{CONTACT_ID}",
headers={"Authorization": f"Bearer {API_KEY}"},
)
const CAMPAIGN_ID = 'cmp_abc123';
const CONTACT_ID = '123e4567-e89b-12d3-a456-426614174000';
await fetch(
`https://data.leadlex.com/functions/v1/api-gateway/v1/campaigns/${CAMPAIGN_ID}/contacts/${CONTACT_ID}`,
{
method: 'DELETE',
headers: { 'Authorization': 'Bearer wbk_your_api_key_here' },
}
);
Example Response
{
"data": {
"removed": true,
"campaign_id": "cmp_abc123",
"contact_id": "123e4567-e89b-12d3-a456-426614174000"
}
}
Errors
| Status | Code | Description |
|---|---|---|
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing campaigns:write permission |
| 404 | campaign_not_found | No campaign with this ID |
| 404 | enrollment_not_found | Contact is not enrolled in this campaign |
| 429 | rate_limited | Rate limit exceeded |