Skip to main content
PATCH
Update an internal note (author only)

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

policyId
string
required
Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
noteId
string
required
Pattern: ^comment(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Body

application/json
content
string
required
Maximum string length: 5000

Response

id
string
required

Id of the internal note (semantic comment id)

Pattern: ^comment(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
policyId
string
required

Id of the policy the note is attached to

content
string
required

Note content

Maximum string length: 5000
author
object
required
createdAt
string<date-time>
required

Date and time when the note was created

updatedAt
string<date-time>
required

Date and time when the note was last updated

isOwn
boolean
required

Whether the calling user authored this note

deletedAt
string<date-time> | null

Date and time when the note was soft-deleted