Skip to main content
POST
Create a new note

Authorizations

X-HYS-API-Key
string
header
required

API key generated from Developer Settings. Format: hys_...

Path Parameters

type
string
required

Type of the note

program_id
integer
required

ID of the program

Body

application/json

Input data format

note
string

The note text

Example:

"This is a note."

entity_id
string
Example:

"1"

donor_id
string
Example:

"1"

client_id
string
Example:

"1"

program_id
string
Example:

"donor"

type
string
Example:

"donor"

categories
string

The category of the note

Example:

"ALL"

Response

Successful operation

message
string

Success message

Example:

"Successful"