Skip to main content
Edit an alert topic

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
is_locked
boolean

Unlock before editing. Locking protects the topic from edits, automatic categorization, merges, splits and automatic removal; it can still be deleted and alerts can still move in and out.

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 with its alert counts and citations.

id
string<uuid>
required
agreement
object | null
required
title
string | null
required
description
string | null
required
is_locked
boolean
required
counts
object
required

Alerts by verdict, each split into credited and uncredited alerts.

organization_currency
object
required

Impact in the organization currency: the sum of the alerts’ converted impacts.

created_at
string<date-time>
required
updated_at
string<date-time>
required
key_questions
string[]
required
evidence
object
required