Skip to main content
POST
Track a whole Discord server as a keyword

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.

Scopes

admin

Path Parameters

The connected server's link id (DiscordServer.linkId).

Required range: x <= 9007199254740991
Example:

12

Body

application/json
channelIds
string[]

Channels to collect; omit or [] for every channel the server link reads. Each id must be a readable channel of the server and inside its channel scope.

Maximum array length: 500

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

Pattern: ^\d{1,20}$
Example:
dailyCap
integer | null

Optional daily budget: posts this server may add per UTC day (1–2000). Omit or null for none: the server's messages then count only toward the workspace's monthly mention allowance.

Required range: 1 <= x <= 2000
Example:

null

tag
enum<string>

The keyword's tag. Default own_brand (a workspace's own community server).

Available options:
own_brand,
competitor,
industry_term
Example:

"own_brand"

color
string

Display colour, #RRGGBB. Default #7c3aed.

Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#6D62F2"

Response

200 response

keyword
object
required

The whole-server keyword (kind: discord_server).

monitor
object
required

Its binding to the server.

alreadyExisted
boolean
required

true when this workspace already tracked the server (by its link, so another invite of the same server counts): nothing new was created and no keyword slot was used.