Integrations

Edit, pause or resume a Discord watch monitor

Sets the monitor’s channelIds ([] = every channel the server link reads), dailyCap (1–2000) and/or paused. paused is the TARGET state, not a toggle: true pauses, false resumes (a monitor whose bot was removed from the server waits for the bot, paused_bot_removed), and repeating it changes nothing. Omitted fields stay. Requires an admin-scoped key; 403 DISCORD_SOURCE_UNAVAILABLE while the Discord source is not enabled for the workspace.

PATCH

api

integrations

discord

monitors

{id}

Edit, pause or resume a Discord watch monitor

curl --request PATCH \
  --url https://app.octolens.com/api/v2/integrations/discord/monitors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelIds": [
    "1290000000000000200"
  ],
  "dailyCap": 100,
  "paused": true
}
'

import requests

url = "https://app.octolens.com/api/v2/integrations/discord/monitors/{id}"

payload = {
    "channelIds": ["1290000000000000200"],
    "dailyCap": 100,
    "paused": True
}
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({channelIds: ['1290000000000000200'], dailyCap: 100, paused: true})
};

fetch('https://app.octolens.com/api/v2/integrations/discord/monitors/{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/integrations/discord/monitors/{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([
    'channelIds' => [
        '1290000000000000200'
    ],
    'dailyCap' => 100,
    'paused' => true
  ]),
  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/integrations/discord/monitors/{id}"

	payload := strings.NewReader("{\n  \"channelIds\": [\n    \"1290000000000000200\"\n  ],\n  \"dailyCap\": 100,\n  \"paused\": true\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/integrations/discord/monitors/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channelIds\": [\n    \"1290000000000000200\"\n  ],\n  \"dailyCap\": 100,\n  \"paused\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/integrations/discord/monitors/{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  \"channelIds\": [\n    \"1290000000000000200\"\n  ],\n  \"dailyCap\": 100,\n  \"paused\": true\n}"

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

{
  "id": 0,
  "linkId": 0,
  "guildId": "1290000000000000200",
  "keywordId": 0,
  "channelIds": [
    "1290000000000000200"
  ],
  "status": "active",
  "dailyCap": 0,
  "todayCount": 0,
  "lastErrorCode": "<string>",
  "estimatedMonthlyMentions": 0,
  "createdAt": "2026-10-28T12:00:00.000Z",
  "updatedAt": "2026-10-28T12:00:00.000Z"
}

{
  "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>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Path Parameters

integer

required

The watch monitor id.

Required range: x <= 9007199254740991

Example:

34

Body

application/json

channelIds

string[]

Channels to watch; [] = every channel the server link reads.

Maximum array length: 500

A Discord snowflake id as a decimal string (64-bit — never parse it as a number).

Pattern: ^\d{1,20}$

dailyCap

integer

Posts this monitor may create per UTC day (12000).

Required range: 1 <= x <= 2000

Example:

100

paused

boolean

Target state, not a toggle: true pauses, false resumes (a monitor whose bot was removed from the server resumes when the bot is back). Idempotent.

Example:

true

Response

200 response

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

linkId

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

guildId

string

required

A Discord snowflake id as a decimal string (64-bit — never parse it as a number).

Pattern: ^\d{1,20}$

Example:

"1290000000000000200"

keywordId

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

channelIds

string[]

required

Watched channel ids; [] = every channel the server link reads.

A Discord snowflake id as a decimal string (64-bit — never parse it as a number).

Pattern: ^\d{1,20}$

status

enum<string>

required

paused: paused by an admin. paused_bot_removed: waits for the bot to be re-added to the server, then resumes on its own.

Available options:

active,

paused,

paused_bot_removed

dailyCap

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

todayCount

integer

required

Posts created so far this UTC day.

Required range: -9007199254740991 <= x <= 9007199254740991

lastErrorCode

string | null

required

e.g. missing_access when the bot can read none of the watched channels.

estimatedMonthlyMentions

integer | null

required

Expected mentions per month at this monitor's cap; null = unknown (no stats yet).

Required range: -9007199254740991 <= x <= 9007199254740991

createdAt

string

required

Example:

"2026-10-28T12:00:00.000Z"

updatedAt

string

required

Example:

"2026-10-28T12:00:00.000Z"

Edit, pause or resume a Discord watch monitor

curl --request PATCH \
  --url https://app.octolens.com/api/v2/integrations/discord/monitors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelIds": [
    "1290000000000000200"
  ],
  "dailyCap": 100,
  "paused": true
}
'

import requests

url = "https://app.octolens.com/api/v2/integrations/discord/monitors/{id}"

payload = {
    "channelIds": ["1290000000000000200"],
    "dailyCap": 100,
    "paused": True
}
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({channelIds: ['1290000000000000200'], dailyCap: 100, paused: true})
};

fetch('https://app.octolens.com/api/v2/integrations/discord/monitors/{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/integrations/discord/monitors/{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([
    'channelIds' => [
        '1290000000000000200'
    ],
    'dailyCap' => 100,
    'paused' => true
  ]),
  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/integrations/discord/monitors/{id}"

	payload := strings.NewReader("{\n  \"channelIds\": [\n    \"1290000000000000200\"\n  ],\n  \"dailyCap\": 100,\n  \"paused\": true\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/integrations/discord/monitors/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channelIds\": [\n    \"1290000000000000200\"\n  ],\n  \"dailyCap\": 100,\n  \"paused\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/integrations/discord/monitors/{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  \"channelIds\": [\n    \"1290000000000000200\"\n  ],\n  \"dailyCap\": 100,\n  \"paused\": true\n}"

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

{
  "id": 0,
  "linkId": 0,
  "guildId": "1290000000000000200",
  "keywordId": 0,
  "channelIds": [
    "1290000000000000200"
  ],
  "status": "active",
  "dailyCap": 0,
  "todayCount": 0,
  "lastErrorCode": "<string>",
  "estimatedMonthlyMentions": 0,
  "createdAt": "2026-10-28T12:00:00.000Z",
  "updatedAt": "2026-10-28T12:00:00.000Z"
}

{
  "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"
  }
}