Sign in

d0dcc5024bd1

latestOpenAPI 3.0.42026-08-104969330.3 KB
Cases

Create a note on a case

Creates a new note/comment on a collection case.

Use Case: Use this endpoint to document activities, record conversations, add reminders, or log any relevant information about the case. Notes are automatically shared with the creditor.

Validation:

  • Description is required (max 10000 characters)
  • EventDate must not be in the future (if provided)

EventDate: Supply EventDate to back-date the note to the time the event actually occurred. For example, if a phone call happened three days ago, pass that date so the timeline reflects the real event order. Omit for real-time notes.

post/cases/{id}/notes

Path parameters

idstring uuid required

Request body

descriptionstring required

Note content

eventDatestring date-time nullable

The date when the event actually occurred. Must not be in the future. When provided, the note will appear at this date in the timeline instead of the upload time. This is useful for importing historical events (e.g. a phone call that happened last week). Omit or set to null to use the current time (default behaviour).

Example request

{
  "description": "Called debtor on 2025-11-19. They acknowledged the debt and promised to pay within 7 days. Will follow up on 2025-11-26.",
  "eventDate": "2025-11-14T09:30:00Z"
}

Response

Note created successfully

idstring uuid
caseReferencestring nullable required
titlestring nullable required
descriptionstring nullable
visibilitystring nullable required
createdAtstring date-time
eventDatestring date-time nullable

The event date provided at creation time. Null if no EventDate was supplied, meaning the note was recorded in real-time (CreatedAt reflects the actual event time).