Archive person

Archive a person, reversibly hiding them from most of the app while keeping their history. A reason is required. Set family to true to archive the rest of their family too. Restore with /api/people/{id}/unarchive. For business profiles this requires the Limited Write Contributions or Full Write Accounting permission instead of the one shown above.

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

Body Params

The archive details.

date-time | null

When the action took effect; defaults to the current date and time when omitted.

reason
object | null

The reason for the action, with code and name.

string | null

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

boolean

When true, the same action cascades to the rest of the person's family members.

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