Add recipients
curl --request POST \
--url https://api.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"phone_number": "+919876543210",
"variables": {
"callee_name": "Jane",
"company": "Acme"
}
}
'import requests
url = "https://api.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients"
payload = {
"phone_number": "+919876543210",
"variables": {
"callee_name": "Jane",
"company": "Acme"
}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_number: '+919876543210',
variables: {callee_name: 'Jane', company: 'Acme'}
})
};
fetch('https://api.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients', 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.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients",
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([
'phone_number' => '+919876543210',
'variables' => [
'callee_name' => 'Jane',
'company' => 'Acme'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients"
payload := strings.NewReader("{\n \"phone_number\": \"+919876543210\",\n \"variables\": {\n \"callee_name\": \"Jane\",\n \"company\": \"Acme\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"+919876543210\",\n \"variables\": {\n \"callee_name\": \"Jane\",\n \"company\": \"Acme\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"+919876543210\",\n \"variables\": {\n \"callee_name\": \"Jane\",\n \"company\": \"Acme\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "recipient_01EXAMPLE",
"campaign_id": "campaign_01EXAMPLE",
"phone_number_masked": "+9***3210",
"status": "pending",
"variables": {
"callee_name": "Jane",
"company": "Acme"
},
"whatsapp_context": {},
"outcome": null,
"answers": null,
"qualified": null,
"next_action_at": null,
"last_customer_message_at": null,
"service_window_expires_at": null,
"created_at": "2026-05-22T10:10:00Z",
"updated_at": "2026-05-22T10:10:00Z"
}
]
}Campaigns
Add recipients
Adds one recipient (a bare object) or many ({ "recipients": [...] }), deduplicated per (campaign, phone). Stored numbers are masked in responses. Scope campaigns:write.
POST
/
campaigns
/
{campaign_id}
/
recipients
Add recipients
curl --request POST \
--url https://api.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"phone_number": "+919876543210",
"variables": {
"callee_name": "Jane",
"company": "Acme"
}
}
'import requests
url = "https://api.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients"
payload = {
"phone_number": "+919876543210",
"variables": {
"callee_name": "Jane",
"company": "Acme"
}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_number: '+919876543210',
variables: {callee_name: 'Jane', company: 'Acme'}
})
};
fetch('https://api.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients', 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.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients",
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([
'phone_number' => '+919876543210',
'variables' => [
'callee_name' => 'Jane',
'company' => 'Acme'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients"
payload := strings.NewReader("{\n \"phone_number\": \"+919876543210\",\n \"variables\": {\n \"callee_name\": \"Jane\",\n \"company\": \"Acme\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"+919876543210\",\n \"variables\": {\n \"callee_name\": \"Jane\",\n \"company\": \"Acme\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lehar.ai/ca/api/v0/campaigns/{campaign_id}/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"+919876543210\",\n \"variables\": {\n \"callee_name\": \"Jane\",\n \"company\": \"Acme\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "recipient_01EXAMPLE",
"campaign_id": "campaign_01EXAMPLE",
"phone_number_masked": "+9***3210",
"status": "pending",
"variables": {
"callee_name": "Jane",
"company": "Acme"
},
"whatsapp_context": {},
"outcome": null,
"answers": null,
"qualified": null,
"next_action_at": null,
"last_customer_message_at": null,
"service_window_expires_at": null,
"created_at": "2026-05-22T10:10:00Z",
"updated_at": "2026-05-22T10:10:00Z"
}
]
}Authorizations
ApiKeyAuthBearerAuth
Path Parameters
Body
application/json
Response
201 - application/json
Upserted recipients (numbers masked)

