Add Single Prospect
curl --request POST \
--url https://api.kakiyo.com/v1/prospects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"campaignId": "campaign_12345abcde",
"name": "John Smith",
"url": "https://linkedin.com/in/johnsmith",
"customData": "John commented on Liam's LinkedIn post about AI outbound."
}
EOFimport requests
url = "https://api.kakiyo.com/v1/prospects"
payload = {
"campaignId": "campaign_12345abcde",
"name": "John Smith",
"url": "https://linkedin.com/in/johnsmith",
"customData": "John commented on Liam's LinkedIn post about AI outbound."
}
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({
campaignId: 'campaign_12345abcde',
name: 'John Smith',
url: 'https://linkedin.com/in/johnsmith',
customData: 'John commented on Liam\'s LinkedIn post about AI outbound.'
})
};
fetch('https://api.kakiyo.com/v1/prospects', 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.kakiyo.com/v1/prospects",
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([
'campaignId' => 'campaign_12345abcde',
'name' => 'John Smith',
'url' => 'https://linkedin.com/in/johnsmith',
'customData' => 'John commented on Liam\'s LinkedIn post about AI outbound.'
]),
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.kakiyo.com/v1/prospects"
payload := strings.NewReader("{\n \"campaignId\": \"campaign_12345abcde\",\n \"name\": \"John Smith\",\n \"url\": \"https://linkedin.com/in/johnsmith\",\n \"customData\": \"John commented on Liam's LinkedIn post about AI outbound.\"\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.kakiyo.com/v1/prospects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"campaignId\": \"campaign_12345abcde\",\n \"name\": \"John Smith\",\n \"url\": \"https://linkedin.com/in/johnsmith\",\n \"customData\": \"John commented on Liam's LinkedIn post about AI outbound.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kakiyo.com/v1/prospects")
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 \"campaignId\": \"campaign_12345abcde\",\n \"name\": \"John Smith\",\n \"url\": \"https://linkedin.com/in/johnsmith\",\n \"customData\": \"John commented on Liam's LinkedIn post about AI outbound.\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Prospect added successfully",
"listId": "import_list_id"
}{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}Prospects
Add Single Prospect
Adds a single prospect to a campaign
POST
/
prospects
Add Single Prospect
curl --request POST \
--url https://api.kakiyo.com/v1/prospects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"campaignId": "campaign_12345abcde",
"name": "John Smith",
"url": "https://linkedin.com/in/johnsmith",
"customData": "John commented on Liam's LinkedIn post about AI outbound."
}
EOFimport requests
url = "https://api.kakiyo.com/v1/prospects"
payload = {
"campaignId": "campaign_12345abcde",
"name": "John Smith",
"url": "https://linkedin.com/in/johnsmith",
"customData": "John commented on Liam's LinkedIn post about AI outbound."
}
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({
campaignId: 'campaign_12345abcde',
name: 'John Smith',
url: 'https://linkedin.com/in/johnsmith',
customData: 'John commented on Liam\'s LinkedIn post about AI outbound.'
})
};
fetch('https://api.kakiyo.com/v1/prospects', 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.kakiyo.com/v1/prospects",
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([
'campaignId' => 'campaign_12345abcde',
'name' => 'John Smith',
'url' => 'https://linkedin.com/in/johnsmith',
'customData' => 'John commented on Liam\'s LinkedIn post about AI outbound.'
]),
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.kakiyo.com/v1/prospects"
payload := strings.NewReader("{\n \"campaignId\": \"campaign_12345abcde\",\n \"name\": \"John Smith\",\n \"url\": \"https://linkedin.com/in/johnsmith\",\n \"customData\": \"John commented on Liam's LinkedIn post about AI outbound.\"\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.kakiyo.com/v1/prospects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"campaignId\": \"campaign_12345abcde\",\n \"name\": \"John Smith\",\n \"url\": \"https://linkedin.com/in/johnsmith\",\n \"customData\": \"John commented on Liam's LinkedIn post about AI outbound.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kakiyo.com/v1/prospects")
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 \"campaignId\": \"campaign_12345abcde\",\n \"name\": \"John Smith\",\n \"url\": \"https://linkedin.com/in/johnsmith\",\n \"customData\": \"John commented on Liam's LinkedIn post about AI outbound.\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Prospect added successfully",
"listId": "import_list_id"
}{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}Overview
Add an individual prospect to a campaign. Prospect imports are processed asynchronously: the response includes alistId that you can use to check processing status.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | Campaign ID that should receive the prospect |
name | string | Yes | Prospect full name |
url | string | Yes | LinkedIn profile URL |
ongoing | boolean | No | Whether the conversation should start as ongoing. Defaults to false |
customData | string | No | Per-conversation context, max 3000 characters. Saved on the created chat and available in prompts as {{customData}} |
Prompt personalization
UsecustomData for context that should be unique to this imported conversation, for example the action that qualified the lead.
In your prompt, reference it with:
{{customData}}
Example
curl -X POST "https://api.kakiyo.com/v1/prospects" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"campaignId": "campaign_12345abcde",
"name": "John Smith",
"url": "https://linkedin.com/in/johnsmith",
"customData": "John commented on Liam's LinkedIn post about AI outbound. Use this as the opening context."
}'
const response = await fetch('https://api.kakiyo.com/v1/prospects', {
method: 'POST',
headers: {
Authorization: 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
campaignId: 'campaign_12345abcde',
name: 'John Smith',
url: 'https://linkedin.com/in/johnsmith',
customData: "John commented on Liam's LinkedIn post about AI outbound. Use this as the opening context.",
}),
});
const result = await response.json();
console.log(result.listId);
Response
{
"message": "Prospect added successfully",
"listId": "import_list_id"
}
Best practices
- Keep
customDataconcise and directly useful for the AI prompt. - Do not include secrets or sensitive private data.
- Confirm import completion with the import status endpoint; creation is asynchronous.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Prospect to add
Last modified on June 20, 2026
⌘I

