Skip to main content
Edit an alert topic

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
title
string | null
Maximum string length: 200
description
string | null

Markdown. Inline citations such as [1] or [1,2] must use the source numbers stored for this topic.

Maximum string length: 100000
key_questions
string[]

Replaces the questions. Send an empty list to clear them.

Maximum array length: 100
Required string length: 1 - 20000

Response

The topic, its alert counts and its citations.

id
string<uuid>
required
agreement
object | null
required
title
string | null
required
description
string | null
required
is_locked
boolean
required
counts
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
key_questions
string[]
required
evidence
object
required