Set or clear deceased date

On a profile marked deceased, sets, changes or clears the Deceased Date. A cleared date leaves the profile "Deceased" with no age.

On any other profile only clearing is allowed, which removes a Deceased Date that was never a death. Setting one there answers 400 deceased_date_requires_mark_desc; use POST /api/people/{id}/deceased instead.

Several stored dates collapse to the one sent. The date in the archive note is not changed. The same rules as Mark Deceased apply: the caller needs the permission at any of the person's campuses or organizations and cannot change their own profile (400 own_profile_status_refused_desc); only a super user can change a super user's (400 super_user_status_refused_desc). A business can never be given a Deceased Date (400 deceased_business_refused_desc), but a date it still holds can be cleared.

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.

Body Params

The date of death, or null to remove it.

Sets, changes or clears a person's Deceased Date.

date | null

The date of death (yyyy-MM-dd). Leave it out or send null to remove the Deceased Date. It cannot be later than the tenant's today, nor before the birthday when the birthday has a month, day and year.

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