Note

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

Overview

This endpoint automatically creates a text note/comment and attaches it to a record.

What it does:

  • Creates a note record - Generates a timestamped note entry in the database
  • Fills in the content - You provide the note body (and optionally a subject line)
  • Supports dynamic content - The note text can include placeholders that automatically fill in with real data from the record (like {ClaimNumber}, {ClaimantName}, USERNAME)
  • Attaches to the parent record - The note appears in the Notes tab/section of the record that triggered the action (claim, policy, incident, etc.)
Recommendation:

Notes can only be meaningfully created on records that support notes (Claims, Policies, Incidents, Contacts, Locations, Transactions, etc.). If you try to create a note on a record type that doesn't support notes (like configuration tables), the note will be created but won't be visible anywhere. It effectively becomes an orphan record.

Path Params
string
required

Recommendation: Only use Note actions on domains that support notes (check domain configuration)

`Note` works with all domains, but with different behavior depending on the domain's `HasNotes` property.

If HasNotes = true (e.g., Claim, Incident, Policy, Transaction, Contact, Location, Task)

  • Note is created and linked to the parent record
  • Note appears in the parent record's Notes tab
  • Note has ParentDomainID and ParentID populated

If HasNotes = false (e.g., most code tables, admin domains)

  • Note is still created in the database
  • Note is not linked to any parent record
  • ParentDomainID and ParentID remain null or 0
  • Note becomes an "orphan" - exists but not visible anywhere in the UI
integer
required

This is the ID of the record serving to which you are adding the note.

Body Params
parameters
object
required
Response

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