Create note

Add a note to the plan. Including an existing note's id updates that note instead. Notes apply to all of the plan's teams unless teams narrows them to specific teams. Returns the note's id and text.

Required permission: Full Write Service Plans

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

The id of the plan

Body Params

The details of the note

category
object | null
required

The note's category. The categories come from the plan's service type.

int32

The id of the note. When creating a note, include an existing note's id to update it instead.

string | null

The text of the note.

teams
object | null

The teams the note applies to: all teams, or specific teams given by their ids in values.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

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