API Reference

Add a note

post
https://api.kalepa.com/external/reports//notes

Add a note to a report. With smart matching enabled the note is attached to the most relevant entity and an existing note may be updated (200); otherwise a new note is created (201).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

the ID of the report

Body Params
string

Content of the note to be added or updated

boolean
Defaults to false

Flag indicating whether the incoming note should be matched with existing notes. If true, the note will be matched with existing notes and the existing note will be updated. If false, a new note will be created.

Responses

400

The request is invalid.

401

The bearer token is missing or invalid.

403

The authenticated client is not permitted to access this resource (e.g. insufficient permissions or org-group scope).

404

The specified report was not found.

500

An unexpected error occurred.

Updated about 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago