Life events

The life events resource is used to track notable events which occur in a member's life.

Life event object

{
  "id": "019f3d31-4adc-74ab-9f5c-0f739d0e4204",
  "tenant": "01988bb8-1cfb-7c87-9326-93op0349288e",
  "member": "01993393-9747-7e6e-8322-498f9666bae9",
  "type": "019f3d18-2e77-7a6a-96fc-jw4zf7n6s8gq",
  "date_from": "2026-07-02",
  "date_to": null,
  "sentiment": 2,
  "impact": 1,
  "notes": null,
  "meta": null,
  "archived_at": null,
  "created_at": "2026-07-07 15:27:48",
  "updated_at": "2026-07-08 16:05:27"
}

Fields

• id
  required readonly string
  Unique ID of the record.
• tenant
  required readonly string
  Unique ID of the tenant.
• member
  required string
  Unique ID of the member.
• type
  required string
  Unique ID of the life event type.
• date_from
  required string
  Date of when the life event began.
• date_to
  nullable string
  Date of when the life event ended. This value must be greater than or equal to date_from.
• sentiment
  nullable integer
  Member's feeling regarding this event. One of:

  • 1: Very negative
  • 2: Somewhat negative
  • 3: Neutral/mixed
  • 4: Somewhat positive
  • 5: Very positive
• impact
  nullable integer
  Overall impact this event had on the member's life. One of:

  • 1: Low
  • 2: Medium
  • 3: High
• notes
  nullable string
  Additional notes regarding the life event.
• meta
  nullable object
  Additional metadata regarding the life event.
• archived_at
  nullable string
  UTC timestamp of when the record was archived.
• created_at
  required readonly string
  UTC timestamp of when the record was created.
• updated_at
  nullable readonly string
  UTC timestamp of when the record was last updated.

Create a life event

POST /tenants/{tenantId}/life-events

The request body must include a life event object.

Required permissions

life_events:create members:read life_event_types:read

Response

List life events

GET /tenants/{tenantId}/life-events

Required permissions

life_events:read members:read life_event_types:read

Response

Read a life event

GET /tenants/{tenantId}/life-events/{id}

Required permissions

life_events:read members:read life_event_types:read

Response

Update a life event

PATCH /tenants/{tenantId}/life-events/{id}

The request body must include parts of a life event object.

Required permissions

life_events:update members:read life_event_types:read

Response

Delete a life event

DELETE /tenants/{tenantId}/life-events/{id}

Required permissions

life_events:delete

Response