Update a feed - Octolens

PATCH

api

feeds

{id}

Update a feed

curl --request PATCH \
  --url https://app.octolens.com/api/v2/feeds/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": "BellIcon",
  "simpleFilters": {
    "conditions": [
      {
        "field": "Keywords",
        "values": "42,43"
      }
    ]
  },
  "advancedFilters": {
    "groups": [
      {
        "conditions": [
          {
            "values": "42,43"
          }
        ],
        "isSingleCondition": true
      }
    ]
  },
  "destinations": [
    {
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3
    }
  ]
}
'

import requests

url = "https://app.octolens.com/api/v2/feeds/{id}"

payload = {
    "name": "<string>",
    "icon": "BellIcon",
    "simpleFilters": { "conditions": [
            {
                "field": "Keywords",
                "values": "42,43"
            }
        ] },
    "advancedFilters": { "groups": [
            {
                "conditions": [{ "values": "42,43" }],
                "isSingleCondition": True
            }
        ] },
    "destinations": [
        {
            "time": "09:00",
            "timezone": "UTC",
            "dayOfWeek": 3
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    icon: 'BellIcon',
    simpleFilters: {conditions: [{field: 'Keywords', values: '42,43'}]},
    advancedFilters: {groups: [{conditions: [{values: '42,43'}], isSingleCondition: true}]},
    destinations: [{time: '09:00', timezone: 'UTC', dayOfWeek: 3}]
  })
};

fetch('https://app.octolens.com/api/v2/feeds/{id}', 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://app.octolens.com/api/v2/feeds/{id}",
  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([
    'name' => '<string>',
    'icon' => 'BellIcon',
    'simpleFilters' => [
        'conditions' => [
                [
                                'field' => 'Keywords',
                                'values' => '42,43'
                ]
        ]
    ],
    'advancedFilters' => [
        'groups' => [
                [
                                'conditions' => [
                                                                [
                                                                                                                                'values' => '42,43'
                                                                ]
                                ],
                                'isSingleCondition' => true
                ]
        ]
    ],
    'destinations' => [
        [
                'time' => '09:00',
                'timezone' => 'UTC',
                'dayOfWeek' => 3
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.octolens.com/api/v2/feeds/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"icon\": \"BellIcon\",\n  \"simpleFilters\": {\n    \"conditions\": [\n      {\n        \"field\": \"Keywords\",\n        \"values\": \"42,43\"\n      }\n    ]\n  },\n  \"advancedFilters\": {\n    \"groups\": [\n      {\n        \"conditions\": [\n          {\n            \"values\": \"42,43\"\n          }\n        ],\n        \"isSingleCondition\": true\n      }\n    ]\n  },\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.octolens.com/api/v2/feeds/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"icon\": \"BellIcon\",\n  \"simpleFilters\": {\n    \"conditions\": [\n      {\n        \"field\": \"Keywords\",\n        \"values\": \"42,43\"\n      }\n    ]\n  },\n  \"advancedFilters\": {\n    \"groups\": [\n      {\n        \"conditions\": [\n          {\n            \"values\": \"42,43\"\n          }\n        ],\n        \"isSingleCondition\": true\n      }\n    ]\n  },\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/feeds/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"icon\": \"BellIcon\",\n  \"simpleFilters\": {\n    \"conditions\": [\n      {\n        \"field\": \"Keywords\",\n        \"values\": \"42,43\"\n      }\n    ]\n  },\n  \"advancedFilters\": {\n    \"groups\": [\n      {\n        \"conditions\": [\n          {\n            \"values\": \"42,43\"\n          }\n        ],\n        \"isSingleCondition\": true\n      }\n    ]\n  },\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 0,
  "name": "Competitor mentions",
  "icon": "BellIcon",
  "simpleFilters": {
    "conditions": [
      {
        "field": "Keywords",
        "values": "42,43"
      }
    ]
  },
  "advancedFilters": {
    "groups": [
      {
        "conditions": [
          {
            "values": "42,43"
          }
        ],
        "isSingleCondition": true
      }
    ]
  },
  "isDefault": true,
  "destinations": [
    {
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3,
      "emailDestination": {
        "emails": "alice@example.com, bob@example.com"
      },
      "slackDestination": {
        "channels": "<string>",
        "channelNamesMap": "<string>"
      },
      "webhookDestination": {
        "url": "https://example.com/webhook"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

Authorizations

Authorization

string

header

required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Path Parameters

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

Body

application/json

Partial update. Passing simpleFilters or advancedFilters replaces that side of the filter; passing null clears it (switch a feed between simple and advanced by sending the new side and null on the old one). Destinations are all-or-nothing — include the full list to update any of them.

name

string

Replace feed name. Max 191 characters.

Required string length: 1 - 191

icon

enum<string>

Icon identifier for UI display (Heroicons outline set).

Available options:

InboxStackIcon,

HeartIcon,

AtSymbolIcon,

ExclamationTriangleIcon,

MegaphoneIcon,

ArrowTrendingUpIcon,

BuildingOffice2Icon,

ArrowTrendingDownIcon,

BellIcon,

BuildingLibraryIcon,

ChartBarIcon,

ChatBubbleLeftIcon,

ChatBubbleLeftRightIcon,

CheckCircleIcon,

CloudIcon,

CodeBracketIcon,

ComputerDesktopIcon,

CursorArrowRaysIcon,

DevicePhoneMobileIcon,

DocumentIcon,

DocumentTextIcon,

EnvelopeIcon,

EyeIcon,

FaceSmileIcon,

FaceFrownIcon,

FireIcon,

FlagIcon,

FolderIcon,

GlobeAltIcon,

GlobeAmericasIcon,

HandThumbUpIcon,

HashtagIcon,

InboxArrowDownIcon,

LightBulbIcon,

PaperClipIcon,

RocketLaunchIcon,

RssIcon,

SignalIcon,

SparklesIcon,

StarIcon,

TrophyIcon,

UserGroupIcon,

WalletIcon

Example:

"BellIcon"

simpleFilters

object | null

Simple AND-combined filter list.

Show child attributes

advancedFilters

object | null

Nested filter expression — groups of conditions combined with AND/OR.

Show child attributes

destinations

object[]

If provided, replaces all destinations. If omitted, destinations are unchanged.

Show child attributes

Response

200 response

A saved filter with optional notification destinations.

integer

required

Feed ID.

Required range: -9007199254740991 <= x <= 9007199254740991

name

string

required

Display name shown in the app and included in notifications.

Example:

"Competitor mentions"

icon

enum<string>

required

Icon identifier for UI display (Heroicons outline set).

Available options:

InboxStackIcon,

HeartIcon,

AtSymbolIcon,

ExclamationTriangleIcon,

MegaphoneIcon,

ArrowTrendingUpIcon,

BuildingOffice2Icon,

ArrowTrendingDownIcon,

BellIcon,

BuildingLibraryIcon,

ChartBarIcon,

ChatBubbleLeftIcon,

ChatBubbleLeftRightIcon,

CheckCircleIcon,

CloudIcon,

CodeBracketIcon,

ComputerDesktopIcon,

CursorArrowRaysIcon,

DevicePhoneMobileIcon,

DocumentIcon,

DocumentTextIcon,

EnvelopeIcon,

EyeIcon,

FaceSmileIcon,

FaceFrownIcon,

FireIcon,

FlagIcon,

FolderIcon,

GlobeAltIcon,

GlobeAmericasIcon,

HandThumbUpIcon,

HashtagIcon,

InboxArrowDownIcon,

LightBulbIcon,

PaperClipIcon,

RocketLaunchIcon,

RssIcon,

SignalIcon,

SparklesIcon,

StarIcon,

TrophyIcon,

UserGroupIcon,

WalletIcon

Example:

"BellIcon"

simpleFilters

object | null

required

Simple AND-combined filter list.

Show child attributes

advancedFilters

object | null

required

Nested filter expression — groups of conditions combined with AND/OR.

Show child attributes

isDefault

boolean

required

If true, this feed is pinned as the org's default view.

destinations

object[]

required

Notification destinations. Empty array = filter-only feed with no notifications.

Show child attributes

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Update a feed

curl --request PATCH \
  --url https://app.octolens.com/api/v2/feeds/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": "BellIcon",
  "simpleFilters": {
    "conditions": [
      {
        "field": "Keywords",
        "values": "42,43"
      }
    ]
  },
  "advancedFilters": {
    "groups": [
      {
        "conditions": [
          {
            "values": "42,43"
          }
        ],
        "isSingleCondition": true
      }
    ]
  },
  "destinations": [
    {
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3
    }
  ]
}
'

import requests

url = "https://app.octolens.com/api/v2/feeds/{id}"

payload = {
    "name": "<string>",
    "icon": "BellIcon",
    "simpleFilters": { "conditions": [
            {
                "field": "Keywords",
                "values": "42,43"
            }
        ] },
    "advancedFilters": { "groups": [
            {
                "conditions": [{ "values": "42,43" }],
                "isSingleCondition": True
            }
        ] },
    "destinations": [
        {
            "time": "09:00",
            "timezone": "UTC",
            "dayOfWeek": 3
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    icon: 'BellIcon',
    simpleFilters: {conditions: [{field: 'Keywords', values: '42,43'}]},
    advancedFilters: {groups: [{conditions: [{values: '42,43'}], isSingleCondition: true}]},
    destinations: [{time: '09:00', timezone: 'UTC', dayOfWeek: 3}]
  })
};

fetch('https://app.octolens.com/api/v2/feeds/{id}', 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://app.octolens.com/api/v2/feeds/{id}",
  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([
    'name' => '<string>',
    'icon' => 'BellIcon',
    'simpleFilters' => [
        'conditions' => [
                [
                                'field' => 'Keywords',
                                'values' => '42,43'
                ]
        ]
    ],
    'advancedFilters' => [
        'groups' => [
                [
                                'conditions' => [
                                                                [
                                                                                                                                'values' => '42,43'
                                                                ]
                                ],
                                'isSingleCondition' => true
                ]
        ]
    ],
    'destinations' => [
        [
                'time' => '09:00',
                'timezone' => 'UTC',
                'dayOfWeek' => 3
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.octolens.com/api/v2/feeds/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"icon\": \"BellIcon\",\n  \"simpleFilters\": {\n    \"conditions\": [\n      {\n        \"field\": \"Keywords\",\n        \"values\": \"42,43\"\n      }\n    ]\n  },\n  \"advancedFilters\": {\n    \"groups\": [\n      {\n        \"conditions\": [\n          {\n            \"values\": \"42,43\"\n          }\n        ],\n        \"isSingleCondition\": true\n      }\n    ]\n  },\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.octolens.com/api/v2/feeds/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"icon\": \"BellIcon\",\n  \"simpleFilters\": {\n    \"conditions\": [\n      {\n        \"field\": \"Keywords\",\n        \"values\": \"42,43\"\n      }\n    ]\n  },\n  \"advancedFilters\": {\n    \"groups\": [\n      {\n        \"conditions\": [\n          {\n            \"values\": \"42,43\"\n          }\n        ],\n        \"isSingleCondition\": true\n      }\n    ]\n  },\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/feeds/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"icon\": \"BellIcon\",\n  \"simpleFilters\": {\n    \"conditions\": [\n      {\n        \"field\": \"Keywords\",\n        \"values\": \"42,43\"\n      }\n    ]\n  },\n  \"advancedFilters\": {\n    \"groups\": [\n      {\n        \"conditions\": [\n          {\n            \"values\": \"42,43\"\n          }\n        ],\n        \"isSingleCondition\": true\n      }\n    ]\n  },\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 0,
  "name": "Competitor mentions",
  "icon": "BellIcon",
  "simpleFilters": {
    "conditions": [
      {
        "field": "Keywords",
        "values": "42,43"
      }
    ]
  },
  "advancedFilters": {
    "groups": [
      {
        "conditions": [
          {
            "values": "42,43"
          }
        ],
        "isSingleCondition": true
      }
    ]
  },
  "isDefault": true,
  "destinations": [
    {
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3,
      "emailDestination": {
        "emails": "alice@example.com, bob@example.com"
      },
      "slackDestination": {
        "channels": "<string>",
        "channelNamesMap": "<string>"
      },
      "webhookDestination": {
        "url": "https://example.com/webhook"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}