Skip to main content
PUT
Update Quiet Day

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

careCommunicationSuppression
integer
required

Quiet-day preference identifier.

Body

application/json
topic
enum<string>

Celebration messages covered by the quiet day.

Available options:
all_celebrations,
birthday,
wedding_anniversary,
baby_and_family
starts_on
string<date>

First quiet day.

ends_on
string<date>

Last quiet day.

pastoral_acknowledgment
boolean

Whether a private pastoral acknowledgment is welcome.

active
boolean

Whether the quiet-day preference is active.

reason
string | null

Optional private reason.

Maximum string length: 2000
member_guidance
string | null

Optional private guidance.

Maximum string length: 2000

Response

The quiet-day preference was updated.

status
string
required

Request result.

Example:

"Success"

data
object
required
message
string

Member-facing result message.