Skip to main content
PUT
Update Private Life Moment

Authorizations

X-API-Key
string
header
required

Client API key copied from Developer Access in the TheFaithApp dashboard.

Authorization
string
header
required

Member access token returned by POST /v1/auth/token.

Path Parameters

careLifeMoment
integer
required

Private life-moment identifier.

Body

application/json
kind
enum<string>

Private life-moment kind.

Available options:
birthday,
grief_anniversary,
illness_check_in,
crisis_follow_up,
hard_anniversary
Example:

"grief_anniversary"

status
enum<string>

Life-moment status editable by the member.

Available options:
active,
paused
Example:

"active"

title
string

Private title.

Required string length: 2 - 160
event_date
string<date>

Private event date.

recurrence
enum<string>

Whether the private date occurs once or yearly.

Available options:
once,
yearly
Example:

"yearly"

reminder_lead_days
integer

Days before the event to remind the care team.

Required range: 0 <= x <= 60
member_note
string | null

Optional private guidance.

Maximum string length: 5000

Response

The private life moment was updated.

status
string
required

Request result.

Example:

"Success"

data
object
required
message
string

Member-facing result message.