const options = {
method: "POST",
headers: {
"x-api-key": "<your-api-key>",
},
};
fetch(
"https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up"
headers = {
"x-api-key": "<your-api-key>",
}
response = requests.request("POST", url, headers=headers)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"leadId": "a9d0a790-201b-47e9-84ed-cc7eed1270c5",
"bodySegments": ["Hi Jordan, just following up on your application."],
"channel": "SMS",
"status": "SENT"
}
Leads
Trigger Follow-up
Evaluate and send a follow-up message to a lead
POST
/
api
/
v1
/
leads
/
{leadId}
/
follow-up
const options = {
method: "POST",
headers: {
"x-api-key": "<your-api-key>",
},
};
fetch(
"https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up"
headers = {
"x-api-key": "<your-api-key>",
}
response = requests.request("POST", url, headers=headers)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"leadId": "a9d0a790-201b-47e9-84ed-cc7eed1270c5",
"bodySegments": ["Hi Jordan, just following up on your application."],
"channel": "SMS",
"status": "SENT"
}
This endpoint triggers the AI agent to evaluate a lead and send a follow-up message. Depending on agent configuration, the follow-up may be sent immediately, scheduled for later, or saved as a draft.
Authentication
Requires thex-api-key header with a valid workspace API key.
Path Parameters
string
required
The unique identifier of the lead
Response
boolean
Whether the follow-up was successfully sent
string
ID of the lead the follow-up was triggered for
string[]
Follow-up message that was sent
enum
Channel used to send the follow-up (e.g.
SMS, EMAIL, WHATSAPP)enum
Status of the follow-up message (e.g.
DRAFT, SCHEDULED, SENT)const options = {
method: "POST",
headers: {
"x-api-key": "<your-api-key>",
},
};
fetch(
"https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up"
headers = {
"x-api-key": "<your-api-key>",
}
response = requests.request("POST", url, headers=headers)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/leads/a9d0a790-201b-47e9-84ed-cc7eed1270c5/follow-up \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"leadId": "a9d0a790-201b-47e9-84ed-cc7eed1270c5",
"bodySegments": ["Hi Jordan, just following up on your application."],
"channel": "SMS",
"status": "SENT"
}