Update campaign segmentation
curl --request PATCH \
--url https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"segmentation": {
"filters": {
"operation": "rent",
"propertyType": "homes"
},
"expectedResults": 50
}
}
'import requests
url = "https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation"
payload = { "segmentation": {
"filters": {
"operation": "rent",
"propertyType": "homes"
},
"expectedResults": 50
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
segmentation: {filters: {operation: 'rent', propertyType: 'homes'}, expectedResults: 50}
})
};
fetch('https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation', 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/v1/public/v1/campaigns/{id}/segmentation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'segmentation' => [
'filters' => [
'operation' => 'rent',
'propertyType' => 'homes'
],
'expectedResults' => 50
]
]),
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/v1/public/v1/campaigns/{id}/segmentation"
payload := strings.NewReader("{\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"propertyType\": \"homes\"\n },\n \"expectedResults\": 50\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"propertyType\": \"homes\"\n },\n \"expectedResults\": 50\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"propertyType\": \"homes\"\n },\n \"expectedResults\": 50\n }\n}"
response = http.request(request)
puts response.read_bodyCampaigns
Update campaign segmentation
Replaces the segmentation object for the campaign.
- Portal campaigns: pass
{ filters: {...}, expectedResults: 50 }using the filter keys fromGET /platforms/{platform}/filters. - CSV campaigns: pass
{ batchSize: 10 }(integer 1–25). - Widget campaigns: segmentation is unused.
PATCH
/
public
/
v1
/
campaigns
/
{id}
/
segmentation
Update campaign segmentation
curl --request PATCH \
--url https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"segmentation": {
"filters": {
"operation": "rent",
"propertyType": "homes"
},
"expectedResults": 50
}
}
'import requests
url = "https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation"
payload = { "segmentation": {
"filters": {
"operation": "rent",
"propertyType": "homes"
},
"expectedResults": 50
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
segmentation: {filters: {operation: 'rent', propertyType: 'homes'}, expectedResults: 50}
})
};
fetch('https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation', 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/v1/public/v1/campaigns/{id}/segmentation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'segmentation' => [
'filters' => [
'operation' => 'rent',
'propertyType' => 'homes'
],
'expectedResults' => 50
]
]),
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/v1/public/v1/campaigns/{id}/segmentation"
payload := strings.NewReader("{\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"propertyType\": \"homes\"\n },\n \"expectedResults\": 50\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"propertyType\": \"homes\"\n },\n \"expectedResults\": 50\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hostreach.io/v1/public/v1/campaigns/{id}/segmentation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"segmentation\": {\n \"filters\": {\n \"operation\": \"rent\",\n \"propertyType\": \"homes\"\n },\n \"expectedResults\": 50\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API key (hr_live_... or hr_test_...). Generate from Settings › Workspace › Acceso API.
Path Parameters
Body
application/json
Platform-specific segmentation object.
Example:
{
"filters": {
"operation": "rent",
"propertyType": "homes"
},
"expectedResults": 50
}
Response
200 - undefined
Was this page helpful?
⌘I