Skip to main content
PUT
Update Pastoral Care Preferences

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
reminders_enabled
boolean

Enable or disable all life-moment reminders.

birthday_follow_up_enabled
boolean

Enable or disable birthday follow-up.

grief_follow_up_enabled
boolean

Enable or disable grief follow-up.

illness_follow_up_enabled
boolean

Enable or disable illness follow-up.

crisis_follow_up_enabled
boolean

Enable or disable crisis follow-up.

hard_anniversary_follow_up_enabled
boolean

Enable or disable hard-anniversary follow-up.

care_radar_enabled
boolean

Enable or disable Care Radar consent.

group_participation_follow_up_enabled
boolean

Enable or disable Community Group participation follow-up consent.

contact_preference
enum<string>

How the member prefers to be contacted.

Available options:
in_app,
phone,
text,
email
Example:

"phone"

acknowledgment_style
enum<string>

Preferred acknowledgment style.

Available options:
gentle,
ask_first,
no_contact

Response

Pastoral Care preferences were updated.

status
string
required

Request result.

Example:

"Success"

data
object
required
message
string

Member-facing result message.