Skip to main content
POST
Create 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.

Body

application/json
kind
enum<string>
required

Private life-moment kind.

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

"grief_anniversary"

title
string
required

Private title.

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

Private event date. One-time dates must be today or later.

recurrence
enum<string>
required

Whether the private date occurs once or yearly.

Available options:
once,
yearly
Example:

"yearly"

reminder_lead_days
integer
required

Days before the event to remind the care team.

Required range: 0 <= x <= 60
status
enum<string>

Life-moment status editable by the member.

Available options:
active,
paused
Example:

"active"

member_note
string | null

Optional private guidance.

Maximum string length: 5000

Response

The private life moment was created.

status
string
required

Request result.

Example:

"Success"

data
object
required
message
string

Member-facing result message.