curl --request POST \
--url https://your-instance.example.com/api/outreach \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "Jamie",
"lastName": "Lee",
"phoneNumber": "+14155550133",
"email": "jamie.lee@example.com",
"source": "Facebook Lead Ad"
}
'import requests
url = "https://your-instance.example.com/api/outreach"
payload = {
"firstName": "Jamie",
"lastName": "Lee",
"phoneNumber": "+14155550133",
"email": "jamie.lee@example.com",
"source": "Facebook Lead Ad"
}
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({
firstName: 'Jamie',
lastName: 'Lee',
phoneNumber: '+14155550133',
email: 'jamie.lee@example.com',
source: 'Facebook Lead Ad'
})
};
fetch('https://your-instance.example.com/api/outreach', 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://your-instance.example.com/api/outreach",
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([
'firstName' => 'Jamie',
'lastName' => 'Lee',
'phoneNumber' => '+14155550133',
'email' => 'jamie.lee@example.com',
'source' => 'Facebook Lead Ad'
]),
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://your-instance.example.com/api/outreach"
payload := strings.NewReader("{\n \"firstName\": \"Jamie\",\n \"lastName\": \"Lee\",\n \"phoneNumber\": \"+14155550133\",\n \"email\": \"jamie.lee@example.com\",\n \"source\": \"Facebook Lead Ad\"\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://your-instance.example.com/api/outreach")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jamie\",\n \"lastName\": \"Lee\",\n \"phoneNumber\": \"+14155550133\",\n \"email\": \"jamie.lee@example.com\",\n \"source\": \"Facebook Lead Ad\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/outreach")
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 \"firstName\": \"Jamie\",\n \"lastName\": \"Lee\",\n \"phoneNumber\": \"+14155550133\",\n \"email\": \"jamie.lee@example.com\",\n \"source\": \"Facebook Lead Ad\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Data processed successfully",
"data": {
"contactId": "64b2c3d4e5f60012345678aa",
"applicationId": "64d2f9c5e8a1d4e001a0b1c2",
"conversationId": "64d2f9c5e8a1d4e001a0b1c3",
"mergeOutcome": "created"
}
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}Trigger outreach processing for a lead
Public endpoint authenticated via API key in Authorization header. Accepts lead data and processes it through the configured lead management pipeline.
curl --request POST \
--url https://your-instance.example.com/api/outreach \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "Jamie",
"lastName": "Lee",
"phoneNumber": "+14155550133",
"email": "jamie.lee@example.com",
"source": "Facebook Lead Ad"
}
'import requests
url = "https://your-instance.example.com/api/outreach"
payload = {
"firstName": "Jamie",
"lastName": "Lee",
"phoneNumber": "+14155550133",
"email": "jamie.lee@example.com",
"source": "Facebook Lead Ad"
}
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({
firstName: 'Jamie',
lastName: 'Lee',
phoneNumber: '+14155550133',
email: 'jamie.lee@example.com',
source: 'Facebook Lead Ad'
})
};
fetch('https://your-instance.example.com/api/outreach', 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://your-instance.example.com/api/outreach",
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([
'firstName' => 'Jamie',
'lastName' => 'Lee',
'phoneNumber' => '+14155550133',
'email' => 'jamie.lee@example.com',
'source' => 'Facebook Lead Ad'
]),
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://your-instance.example.com/api/outreach"
payload := strings.NewReader("{\n \"firstName\": \"Jamie\",\n \"lastName\": \"Lee\",\n \"phoneNumber\": \"+14155550133\",\n \"email\": \"jamie.lee@example.com\",\n \"source\": \"Facebook Lead Ad\"\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://your-instance.example.com/api/outreach")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jamie\",\n \"lastName\": \"Lee\",\n \"phoneNumber\": \"+14155550133\",\n \"email\": \"jamie.lee@example.com\",\n \"source\": \"Facebook Lead Ad\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/outreach")
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 \"firstName\": \"Jamie\",\n \"lastName\": \"Lee\",\n \"phoneNumber\": \"+14155550133\",\n \"email\": \"jamie.lee@example.com\",\n \"source\": \"Facebook Lead Ad\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Data processed successfully",
"data": {
"contactId": "64b2c3d4e5f60012345678aa",
"applicationId": "64d2f9c5e8a1d4e001a0b1c2",
"conversationId": "64d2f9c5e8a1d4e001a0b1c3",
"mergeOutcome": "created"
}
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Lead data payload. Accepts arbitrary additional fields that are mapped to contact dynamic properties.
Lead phone number; normalized to E.164 server-side. Required unless contactId/_id/id is supplied.
Lead email; normalized to lowercase.
Lead first name used when creating a new contact.
Lead last name used when creating a new contact.
Single-field display name fallback when firstName/lastName are not supplied.
Contact _id for an existing contact; bypasses the create-or-merge lookup.
Contact _id for an existing contact; bypasses the create-or-merge lookup.
Contact _id for an existing contact; bypasses the create-or-merge lookup.