Update a stream
curl --request PATCH \
--url https://api.example.com/api/v2/streams/{streamId}import requests
url = "https://api.example.com/api/v2/streams/{streamId}"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/api/v2/streams/{streamId}', 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.example.com/api/v2/streams/{streamId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/streams/{streamId}"
req, _ := http.NewRequest("PATCH", url, nil)
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.example.com/api/v2/streams/{streamId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/streams/{streamId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyStreams (campaigns)
Update a stream
Update any setting on a campaign. Pairs are full-replace.
PATCH
/
api
/
v2
/
streams
/
{streamId}
Update a stream
curl --request PATCH \
--url https://api.example.com/api/v2/streams/{streamId}import requests
url = "https://api.example.com/api/v2/streams/{streamId}"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/api/v2/streams/{streamId}', 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.example.com/api/v2/streams/{streamId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/streams/{streamId}"
req, _ := http.NewRequest("PATCH", url, nil)
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.example.com/api/v2/streams/{streamId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/streams/{streamId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyUpdates any subset of campaign settings. The
pairs field, when present, is treated as a full-replace array: server diffs against existing pairs, adds new (upserting accounts + creating inline segments), removes ones not in the new list.
Body (all fields optional)
| Field | Type | Notes |
|---|---|---|
name | string | Rename the campaign |
pairs | array | Full-replace array. Each pair uses the same shape as Create stream. |
syncTimes | array | ["HH:MM"] slots |
timezone | string | IANA timezone |
autoEnrichLinkedin | boolean | |
autoEnrichEmail | boolean | |
emailMode | enum | "verified" or "any" |
emailDigestOverride | enum | "after_every_sync", "daily", "weekly", "off" or null |
telegramOverride | boolean | or null |
deliveryDestination | enum | "leads_only" or "leads_plus_webhook" |
webhookUrl | string | or null |
csvEmailRecipients | object | {to, cc?, format} or null |
isActive | boolean | Pause/resume |
isArchived | boolean |
Response
{
"id": 42,
"pairsDiff": {
"addedAccounts": [{ "handle": "newhandle", "accountId": 9, "accountCreated": true, "billingDelta": "stripe_quantity_incremented" }],
"addedSegments": [{ "segmentId": 15, "segmentCreated": true }]
}
}
pairsDiff is omitted when pairs wasn’t in the request body.
Auth
Bearer or session cookie.⌘I