Restore person

Restore (unarchive) a previously archived person, clearing the deceased marker if it was set — restoring is how a profile marked deceased by mistake is put right. Set family to true to also restore their archived family members, except any archived as deceased. Activity recorded against a deceased profile (giving, check-in, group or form sign-up) never restores it; only this endpoint does. For business profiles this requires the Limited Write Contributions or Full Write Accounting permission instead of the one shown above.

Required permission: Profile Activate

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 restore.

Body Params

The restore details.

string | null

Free-text comments stored as a note alongside the restore action.

boolean

When true, also restores the person's archived family members, apart from any archived as deceased.

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