Skip to content

Resolve Note Thread

POST
/notes/{note_id}/resolve

Mark this note’s discussion resolved.

Idempotent - re-resolving returns the existing row rather than creating a second one. The replies are untouched.

Authorizations

Parameters

Path Parameters

note_id
required

Note id (UUID).

string

Note id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Mark a discussion thread resolved.

Distinct from completing the task: a task can be done with an unresolved thread and vice versa. Idempotent - re-resolving returns the existing row.

object
resolution_note
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string