Create note

post

https://{apiHost}/api/v2/public/notes

Create a new activity log note. Requires content, entity reference,
occurrence date, at least one category, and communication type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Input for creating a new note

content

string

required

length ≤ 50000

Note content (max 50000 characters)

entityType

string

enum

required

Type of profile to attach note to

Allowed:

entityId

string

required

ID of the profile to attach note to

occurrenceDate

date-time

required

When the activity/event occurred (ISO 8601)

categoryIds

array of strings

required

length ≥ 1

At least one category ID required

categoryIds*

communicationType

string

enum

required

How the information was received

reporterType

string

enum

Who provided the information

Allowed:

reporterProfileId

string

Profile ID if reporter is in the system

reporterUserId

string

User ID if reporter is a system user

reporterExternalName

string

length ≤ 255

Name for external reporters (max 255 characters)

locationId

string

Optional geo/location override

Responses

201Note created successfully

404Resource not found