curl --request POST \
--url https://api.compensable.live/tracking/campaigns/{campaign_code}/outbound \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to_e164": "<string>",
"consent_basis": "<string>",
"funnel_node": "<string>",
"scenario_ref": "<string>",
"template_id": "<string>",
"dynamic_variables": {},
"lead_timezone": "<string>",
"cadence_step": 1,
"idempotency_key": "<string>",
"dry_run": false
}
'import requests
url = "https://api.compensable.live/tracking/campaigns/{campaign_code}/outbound"
payload = {
"to_e164": "<string>",
"consent_basis": "<string>",
"funnel_node": "<string>",
"scenario_ref": "<string>",
"template_id": "<string>",
"dynamic_variables": {},
"lead_timezone": "<string>",
"cadence_step": 1,
"idempotency_key": "<string>",
"dry_run": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to_e164: '<string>',
consent_basis: '<string>',
funnel_node: '<string>',
scenario_ref: '<string>',
template_id: '<string>',
dynamic_variables: {},
lead_timezone: '<string>',
cadence_step: 1,
idempotency_key: '<string>',
dry_run: false
})
};
fetch('https://api.compensable.live/tracking/campaigns/{campaign_code}/outbound', 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.compensable.live/tracking/campaigns/{campaign_code}/outbound",
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([
'to_e164' => '<string>',
'consent_basis' => '<string>',
'funnel_node' => '<string>',
'scenario_ref' => '<string>',
'template_id' => '<string>',
'dynamic_variables' => [
],
'lead_timezone' => '<string>',
'cadence_step' => 1,
'idempotency_key' => '<string>',
'dry_run' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.compensable.live/tracking/campaigns/{campaign_code}/outbound"
payload := strings.NewReader("{\n \"to_e164\": \"<string>\",\n \"consent_basis\": \"<string>\",\n \"funnel_node\": \"<string>\",\n \"scenario_ref\": \"<string>\",\n \"template_id\": \"<string>\",\n \"dynamic_variables\": {},\n \"lead_timezone\": \"<string>\",\n \"cadence_step\": 1,\n \"idempotency_key\": \"<string>\",\n \"dry_run\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.compensable.live/tracking/campaigns/{campaign_code}/outbound")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to_e164\": \"<string>\",\n \"consent_basis\": \"<string>\",\n \"funnel_node\": \"<string>\",\n \"scenario_ref\": \"<string>\",\n \"template_id\": \"<string>\",\n \"dynamic_variables\": {},\n \"lead_timezone\": \"<string>\",\n \"cadence_step\": 1,\n \"idempotency_key\": \"<string>\",\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.compensable.live/tracking/campaigns/{campaign_code}/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to_e164\": \"<string>\",\n \"consent_basis\": \"<string>\",\n \"funnel_node\": \"<string>\",\n \"scenario_ref\": \"<string>\",\n \"template_id\": \"<string>\",\n \"dynamic_variables\": {},\n \"lead_timezone\": \"<string>\",\n \"cadence_step\": 1,\n \"idempotency_key\": \"<string>\",\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Execute an outbound touch
Execute one governed outbound touch (call, SMS, or voicemail drop) for a contact in a campaign. The touch runs through the campaign’s consent, quiet-hours, and frequency checks before it is placed.
curl --request POST \
--url https://api.compensable.live/tracking/campaigns/{campaign_code}/outbound \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to_e164": "<string>",
"consent_basis": "<string>",
"funnel_node": "<string>",
"scenario_ref": "<string>",
"template_id": "<string>",
"dynamic_variables": {},
"lead_timezone": "<string>",
"cadence_step": 1,
"idempotency_key": "<string>",
"dry_run": false
}
'import requests
url = "https://api.compensable.live/tracking/campaigns/{campaign_code}/outbound"
payload = {
"to_e164": "<string>",
"consent_basis": "<string>",
"funnel_node": "<string>",
"scenario_ref": "<string>",
"template_id": "<string>",
"dynamic_variables": {},
"lead_timezone": "<string>",
"cadence_step": 1,
"idempotency_key": "<string>",
"dry_run": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to_e164: '<string>',
consent_basis: '<string>',
funnel_node: '<string>',
scenario_ref: '<string>',
template_id: '<string>',
dynamic_variables: {},
lead_timezone: '<string>',
cadence_step: 1,
idempotency_key: '<string>',
dry_run: false
})
};
fetch('https://api.compensable.live/tracking/campaigns/{campaign_code}/outbound', 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.compensable.live/tracking/campaigns/{campaign_code}/outbound",
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([
'to_e164' => '<string>',
'consent_basis' => '<string>',
'funnel_node' => '<string>',
'scenario_ref' => '<string>',
'template_id' => '<string>',
'dynamic_variables' => [
],
'lead_timezone' => '<string>',
'cadence_step' => 1,
'idempotency_key' => '<string>',
'dry_run' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.compensable.live/tracking/campaigns/{campaign_code}/outbound"
payload := strings.NewReader("{\n \"to_e164\": \"<string>\",\n \"consent_basis\": \"<string>\",\n \"funnel_node\": \"<string>\",\n \"scenario_ref\": \"<string>\",\n \"template_id\": \"<string>\",\n \"dynamic_variables\": {},\n \"lead_timezone\": \"<string>\",\n \"cadence_step\": 1,\n \"idempotency_key\": \"<string>\",\n \"dry_run\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.compensable.live/tracking/campaigns/{campaign_code}/outbound")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to_e164\": \"<string>\",\n \"consent_basis\": \"<string>\",\n \"funnel_node\": \"<string>\",\n \"scenario_ref\": \"<string>\",\n \"template_id\": \"<string>\",\n \"dynamic_variables\": {},\n \"lead_timezone\": \"<string>\",\n \"cadence_step\": 1,\n \"idempotency_key\": \"<string>\",\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.compensable.live/tracking/campaigns/{campaign_code}/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to_e164\": \"<string>\",\n \"consent_basis\": \"<string>\",\n \"funnel_node\": \"<string>\",\n \"scenario_ref\": \"<string>\",\n \"template_id\": \"<string>\",\n \"dynamic_variables\": {},\n \"lead_timezone\": \"<string>\",\n \"cadence_step\": 1,\n \"idempotency_key\": \"<string>\",\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Tenant API key, sent as Authorization: Bearer cmp_live_…. Keys are org-scoped and carry explicit scopes (enroll, execute). Any missing, malformed, unknown, revoked, or expired credential returns a generic 401 invalid_api_key.
Path Parameters
Body
One governed outbound-touch request. extra="forbid" makes an unknown
key a loud 422 rather than a silently-ignored typo.
campaign_code is NOT a body field — it is the path parameter, and the org
id comes from the presenting API key, so neither can be spoofed via the body.
consent_basis is REQUIRED: the caller asserts the TCPA basis and the
service verifies it against the tier on file (never trusted verbatim).
funnel_node selects a variants[funnel_node] entry in the campaign
config (the two-funnel-variant deliverable); absent → the flat base config.
call, sms, voicemail 1 - 321 - 3225625625664x >= 0128Response
Successful Response