Mark person deceased

Record the person's Deceased Date and archive the profile, signing the person out of every session. The Deceased Date is the only place the date of death is kept; read it back as deceasedDate on GET /api/people/{id}. Archiving ends the person's active pledges and current group memberships, declines their upcoming serving assignments, stops their recurring gifts, expires their active safeguards, removes their system access (username, password, linked sign-ins, super user, campus limits and permission overrides), removes them as an approver, bill reminder, workflow manager, task assignee or responder, position leader, group member manager, connection assignee and upcoming event organizer, deletes their pending position requests and process queue entries (a finished workflow step about them stays), and takes them out of chat channels other than direct messages. On a profile already archived for another reason, those steps already ran and are skipped; the profile is still marked deceased and the archive note is still written, dated the Deceased Date and reading "Deceased" plus comments.

The caller needs the permission at any of the person's campuses or organizations, and cannot mark their own profile (400 own_profile_status_refused_desc). Only a super user can mark a super user (400 super_user_status_refused_desc). A caller limited to some campuses or organizations cannot act on the person behind an API key whose access reaches outside their own (400 permission_change_outside_access_desc). A business is never marked deceased (400 deceased_business_refused_desc).

The optional cleanup runs before the archive, and every chosen option is checked before anything changes:

  • familyManagerId: only when the person is the Family Manager. Names a family member who is not archived and not a business, and whom the caller may write at that member's own campuses. Needs Limited Write People and Limited Read People, with write access to the family, to the person and to every other Family Manager.
  • pledges: moves the listed active pledges to personId, who keeps each pledge's amounts and dates. A moved pledge includes the household (household on the pledge), so the gifts the person already gave keep counting toward it. Needs Full Write Pledges at each campaign's campus and organization, and personId must be someone the caller could name on a pledge (403 deceased_option_refused_desc). A pledge in an archived organization is refused (400 organization_archived_record_desc), and so is a pledge when there is another pledge on that campaign by a family member, the person and personId included, that would count the same gifts: one whose dates overlap or, on a campaign that accepts early payments, an earlier one that includes the household or any later one (400 deceased_pledge_duplicate_desc).
  • groups: adds personId to the listed groups as a regular member, never with an earlier role, admin, special access or position. Needs the right to manage that group's members, and personId must be someone the caller may add to a group (403 deceased_option_refused_desc). A current member is skipped, and a past member's latest membership reopens from today. The person's own seat is freed in the same save, so a family member can take it in a full group. A group still at its maximum capacity after that is refused (400 mark_deceased_group_full_desc, with values.group naming the group), and so is a group with no type (400 mark_deceased_group_type_desc, with values.group).
  • spouseWidowed: sets a married spouse who is not archived and not a business to Widowed, keeping the anniversary. Needs permission to edit the spouse's profile.

The personId of pledges and groups must be a family member who is not archived, not a business, and visible to the caller on the profile. An id that is not such a member, like any other option that does not apply to the person, is refused (400 deceased_option_not_applicable_desc); an option the caller lacks permission for is refused (403 deceased_option_refused_desc). The date is required (400 deceased_date_required_desc), cannot be later than today (400 deceased_date_future_desc) and cannot be before a birthday that has a month, day and year (400 deceased_date_before_birthday_desc). A profile already marked deceased is refused (400 deceased_already_marked_desc). To change or clear the Deceased Date later, use PUT /api/people/{id}/deceased.

Required permission: Profile Deactivate

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the person to mark deceased.

Body Params

The Deceased Date, comments and the cleanup options.

Marks a person deceased: the Deceased Date, optional comments, and the family cleanup to apply before the profile is archived.

date | null

The Deceased Date (yyyy-MM-dd). Required; it cannot be later than the tenant's today, nor before the birthday when the birthday has a month, day and year.

string | null

Optional comments, added after "Deceased: " to the archive note. Blank is treated as none.

int32 | null

The id of the family member who becomes Family Manager in place of the deceased. Only when the deceased is the Family Manager; the member must not be archived or a business, and the caller must be able to write them at their own campuses, and every other Family Manager at theirs. Omit to leave the family as it is.

pledges
object | null

Active pledges of the deceased to move to a family member, who keeps each pledge's amounts and dates. A moved pledge includes the household, so the gifts the deceased already gave keep counting toward it. A pledge cannot move while there is another pledge on that campaign by a family member, the deceased and the recipient included, that would count the same gifts: one whose dates overlap or, on a campaign that accepts early payments, an earlier one that includes the household or any later one (400 deceased_pledge_duplicate_desc). Omit, or send no ids, to let archiving end them.

groups
object | null

Current group memberships of the deceased whose groups a family member joins as a regular member. Omit, or send no ids, to add no one.

boolean

When true, sets the spouse's marital status to Widowed and keeps their anniversary. Only for a married spouse who is not archived and not a business.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json