Delete person

Permanently delete a person and their associated records. Set family to true to also delete the rest of the person's family. To reversibly hide a person instead, archive them with /api/people/{id}/archive. For business profiles, deletion requires the Limited Write Contributions or Full Write Accounting permission instead of the one shown above.

Required permission: Full Write People

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

Body Params

Delete options.

boolean

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

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!