curl --request POST \
--url https://api.hostreach.io/v2/public/v1/campaigns \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"platform": "idealista",
"name": "Valencia — Rent Q3 2026",
"mode": "extract_and_contact",
"contactMode": "whatsapp",
"segmentation": {
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46",
"label": "Valencia"
}
},
"expectedResults": 50
},
"settings": "<unknown>"
}
'import requests
url = "https://api.hostreach.io/v2/public/v1/campaigns"
payload = {
"platform": "idealista",
"name": "Valencia — Rent Q3 2026",
"mode": "extract_and_contact",
"contactMode": "whatsapp",
"segmentation": {
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46",
"label": "Valencia"
}
},
"expectedResults": 50
},
"settings": "<unknown>"
}
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({
platform: 'idealista',
name: 'Valencia — Rent Q3 2026',
mode: 'extract_and_contact',
contactMode: 'whatsapp',
segmentation: {
filters: {operation: 'rent', location: {id: '0-EU-ES-VC-46', label: 'Valencia'}},
expectedResults: 50
},
settings: '<unknown>'
})
};
fetch('https://api.hostreach.io/v2/public/v1/campaigns', 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.hostreach.io/v2/public/v1/campaigns",
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([
'platform' => 'idealista',
'name' => 'Valencia — Rent Q3 2026',
'mode' => 'extract_and_contact',
'contactMode' => 'whatsapp',
'segmentation' => [
'filters' => [
'operation' => 'rent',
'location' => [
'id' => '0-EU-ES-VC-46',
'label' => 'Valencia'
]
],
'expectedResults' => 50
],
'settings' => '<unknown>'
]),
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.hostreach.io/v2/public/v1/campaigns"
payload := strings.NewReader("{\n \"platform\": \"idealista\",\n \"name\": \"Valencia — Rent Q3 2026\",\n \"mode\": \"extract_and_contact\",\n \"contactMode\": \"whatsapp\",\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46\",\n \"label\": \"Valencia\"\n }\n },\n \"expectedResults\": 50\n },\n \"settings\": \"<unknown>\"\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.hostreach.io/v2/public/v1/campaigns")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"platform\": \"idealista\",\n \"name\": \"Valencia — Rent Q3 2026\",\n \"mode\": \"extract_and_contact\",\n \"contactMode\": \"whatsapp\",\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46\",\n \"label\": \"Valencia\"\n }\n },\n \"expectedResults\": 50\n },\n \"settings\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hostreach.io/v2/public/v1/campaigns")
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 \"platform\": \"idealista\",\n \"name\": \"Valencia — Rent Q3 2026\",\n \"mode\": \"extract_and_contact\",\n \"contactMode\": \"whatsapp\",\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46\",\n \"label\": \"Valencia\"\n }\n },\n \"expectedResults\": 50\n },\n \"settings\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_bodyCreate a campaign
Creates a campaign in draft status. Use PATCH /:id/status to set it to running.
By platform type:
- Portal (
idealista,fotocasa,metrocuadrado,inmuebles24,zonaprop): Leads are extracted from the real-estate portal on schedule or viaPOST /:id/execute. Includesegmentation.filtersandsegmentation.expectedResults. - CSV import (
csv_import): Upload leads via the dashboard; sent on a drip schedule. Requiressegmentation.batchSize(1–25) andsettings.scheduledHours/Daysbefore goingrunning. - Widget (
widget): Leads arrive from your embedded widget. Only onerunningwidget campaign per workspace.
curl --request POST \
--url https://api.hostreach.io/v2/public/v1/campaigns \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"platform": "idealista",
"name": "Valencia — Rent Q3 2026",
"mode": "extract_and_contact",
"contactMode": "whatsapp",
"segmentation": {
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46",
"label": "Valencia"
}
},
"expectedResults": 50
},
"settings": "<unknown>"
}
'import requests
url = "https://api.hostreach.io/v2/public/v1/campaigns"
payload = {
"platform": "idealista",
"name": "Valencia — Rent Q3 2026",
"mode": "extract_and_contact",
"contactMode": "whatsapp",
"segmentation": {
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46",
"label": "Valencia"
}
},
"expectedResults": 50
},
"settings": "<unknown>"
}
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({
platform: 'idealista',
name: 'Valencia — Rent Q3 2026',
mode: 'extract_and_contact',
contactMode: 'whatsapp',
segmentation: {
filters: {operation: 'rent', location: {id: '0-EU-ES-VC-46', label: 'Valencia'}},
expectedResults: 50
},
settings: '<unknown>'
})
};
fetch('https://api.hostreach.io/v2/public/v1/campaigns', 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.hostreach.io/v2/public/v1/campaigns",
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([
'platform' => 'idealista',
'name' => 'Valencia — Rent Q3 2026',
'mode' => 'extract_and_contact',
'contactMode' => 'whatsapp',
'segmentation' => [
'filters' => [
'operation' => 'rent',
'location' => [
'id' => '0-EU-ES-VC-46',
'label' => 'Valencia'
]
],
'expectedResults' => 50
],
'settings' => '<unknown>'
]),
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.hostreach.io/v2/public/v1/campaigns"
payload := strings.NewReader("{\n \"platform\": \"idealista\",\n \"name\": \"Valencia — Rent Q3 2026\",\n \"mode\": \"extract_and_contact\",\n \"contactMode\": \"whatsapp\",\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46\",\n \"label\": \"Valencia\"\n }\n },\n \"expectedResults\": 50\n },\n \"settings\": \"<unknown>\"\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.hostreach.io/v2/public/v1/campaigns")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"platform\": \"idealista\",\n \"name\": \"Valencia — Rent Q3 2026\",\n \"mode\": \"extract_and_contact\",\n \"contactMode\": \"whatsapp\",\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46\",\n \"label\": \"Valencia\"\n }\n },\n \"expectedResults\": 50\n },\n \"settings\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hostreach.io/v2/public/v1/campaigns")
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 \"platform\": \"idealista\",\n \"name\": \"Valencia — Rent Q3 2026\",\n \"mode\": \"extract_and_contact\",\n \"contactMode\": \"whatsapp\",\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46\",\n \"label\": \"Valencia\"\n }\n },\n \"expectedResults\": 50\n },\n \"settings\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API key (hr_live_... or hr_test_...). Generate from Settings › Workspace › Acceso API.
Body
Campaign platform — determines how leads enter the campaign.
idealista/fotocasa/metrocuadrado/inmuebles24/zonaprop: Portal extraction via scheduled or manual runs.csv_import: Leads uploaded as CSV; sent on a drip schedule. Requiressegmentation.batchSize(1–25) andsettings.scheduledHours/Daysbefore goingrunning.widget: Leads from your embedded widget form. Only onerunningwidget campaign allowed per workspace.
idealista, fotocasa, metrocuadrado, inmuebles24, zonaprop, widget, csv_import "idealista"
Campaign name. Defaults to "Untitled Campaign" if omitted.
255"Valencia — Rent Q3 2026"
Controls what happens after leads are extracted.
extract_only: Scrape leads only; no outreach messages sent.extract_and_contact: Scrape leads and send the configured WhatsApp sequence.
Automatically forced to extract_and_contact for widget and csv_import campaigns.
extract_only, extract_and_contact "extract_and_contact"
Outreach channel to use when sending messages.
whatsapp: WhatsApp Business API (requires connected account).whatsapp-no-api: Manual WhatsApp (no account required).
whatsapp, whatsapp-no-api "whatsapp"
Platform-specific segmentation / filter configuration.
Portal campaigns: { filters: <portal-filter-object>, expectedResults: 50 }. Use GET /platforms/{platform}/filters to discover valid filter keys and GET /platforms/{platform}/locations to look up location values.
CSV import: { batchSize: 10 } — number of leads to contact per scheduled run (1–25). Required before setting status to running.
Widget: leave empty.
{
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46",
"label": "Valencia"
}
},
"expectedResults": 50
}
Scheduling and messaging settings. scheduledHours and scheduledDays are required for csv_import campaigns before setting status to running.
Response
Was this page helpful?