Skip to main content
POST
Execute an outbound touch

Authorizations

Authorization
string
header
required

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

campaign_code
string
required

Body

application/json

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.

channel
enum<string>
required
Available options:
call,
sms,
voicemail
to_e164
string
required
Required string length: 1 - 32
Required string length: 1 - 32
funnel_node
string | null
Maximum string length: 256
scenario_ref
string | null
Maximum string length: 256
template_id
string | null
Maximum string length: 256
dynamic_variables
Dynamic Variables · object
lead_timezone
string | null
Maximum string length: 64
cadence_step
integer
default:1
Required range: x >= 0
idempotency_key
string | null
Maximum string length: 128
dry_run
boolean
default:false

Response

Successful Response