Skip to main content
POST
Create a new note

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

New note and profile context.

note
string
required

Note body. Validation rule: required|min:3|string.

Minimum string length: 3
Example:

"Called to thank the donor."

type
enum<string>
required

Profile type. Validation rule: required|string|in:entity,donor.

Available options:
entity,
donor
Example:

"donor"

entity_id
integer

Recipient ID; required when type is entity. The service resolves it within the caller's organization.

Example:

321

donor_id
integer

Donor ID; required when type is donor. The service resolves it within the caller's organization.

Example:

12345

program_id
integer

Required when type is entity. Category ownership is resolved from the recipient's stored program.

Example:

77

categories
string | null

Category name; omitted or blank names resolve to uncategorized. Validation rule: nullable|string|max:255.

Maximum string length: 255
Example:

"Phone call"

Response

Note created successfully

status
string
Example:

"success"

message
string
Example:

"Note created successfully"

data
object