Add timeline event

Add a new status change event to the client timeline. This is the proper
way to change a client's status, as it maintains audit history.

Valid Status Transitions:

  • prospectprocessing, inactive, never-serviced
  • processingactive, inactive, never-serviced
  • activeonhold, inactive, hospitalized, hospitalized-er, in-facility
  • onholdactive, inactive
  • hospitalized / hospitalized-eractive, inactive, pending-discharge
  • in-facilityactive, inactive
  • pending-dischargeactive, inactive
  • inactiveactive (reactivation)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique client identifier

Body Params

Timeline event input. Events are recorded to track client status changes and care milestones.

The eventType determines what happened (e.g., ADMITTED_TO_HOSPITAL, DISCHARGE_FROM_CARE).
Some events may automatically update the client's status.

Use GET /config/timeline-event-types to retrieve valid event types (if endpoint exists),
or refer to TimelineConst.TIMELINE_EVENT_LIST in the codebase.

string
required

Type of timeline event. Examples:

  • ADMITTED_TO_FACILITY
  • ADMITTED_TO_HOSPITAL
  • NEVER_SERVICED
  • ON_HOLD
  • DISCHARGE_FROM_CARE
  • DISCHARGE_TO_COMMUNITY
  • PRIOR_TO_CARE
date-time

When the event occurred (defaults to current time if not provided)

string

Optional notes about the event

Responses

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