HomeGuidesAPI Reference
Log In
API Reference

Redact patient

Redact all PII for a patient and their associated appointments, messages and events. The patient must have no scheduled or scheduling appointments, otherwise the request is rejected with a 400. If any errors are returned, the redaction is incomplete. Available only to organisations with patient redaction enabled. In test mode, redaction is always available.

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

Pass the patient Id. The format is a string starting with p_

Responses

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