Skip to main content
PATCH
/
api
/
v2
/
streams
/
{streamId}
Update a stream
curl --request PATCH \
  --url https://api.example.com/api/v2/streams/{streamId}
Updates 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)

FieldTypeNotes
namestringRename the campaign
pairsarrayFull-replace array. Each pair uses the same shape as Create stream.
syncTimesarray["HH:MM"] slots
timezonestringIANA timezone
autoEnrichLinkedinboolean
autoEnrichEmailboolean
emailModeenum"verified" or "any"
emailDigestOverrideenum"after_every_sync", "daily", "weekly", "off" or null
telegramOverridebooleanor null
deliveryDestinationenum"leads_only" or "leads_plus_webhook"
webhookUrlstringor null
csvEmailRecipientsobject{to, cc?, format} or null
isActivebooleanPause/resume
isArchivedboolean

​
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.