šŸ”“ Add, update, or clear the note of an uploaded intake

Overwrites the optional plain-text note stored on an intake image. This note will be shared to APIUserManagers as an extra piece of information for the intake.
Comments can serve as a one-way channel for APIUsers to communicate to APIUserManagers.

This endpoint is available only to authenticated APIUsers who own the image and whose plan includes the Monitor-or-higher intake comment service. Send an empty string to clear the existing note; the API stores it as null.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the intake image whose note will be updated.

Body Params

Plain-text note to store. The property is required, and an empty string clears the note.

string
required
length ≤ 255

Optional plain-text note. Send an empty string to clear the stored note.

Responses

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