Skip to main content

Update a test patient

Updates a test patient's details. Email cannot be changed. Password can be regenerated by setting regeneratePassword: true or set explicitly via the password field.

Path Parameters
orgId string — REQUIRED

Organization ID

patientId string — REQUIRED

Test Patient ID

Request Body — REQUIRED

Fields to update. All fields are optional. Set regeneratePassword: true to generate a new password, or provide password to set a specific password.

firstName string

New first name for the test patient

lastName string

New last name for the test patient

dateOfBirth string

New date of birth in ISO format (YYYY-MM-DD)

regeneratePassword boolean

Set to true to generate a new random password

password string

Set a specific password instead of generating one

Responses
200

Updated test patient details. The password field is only included if a new password was generated or explicitly set.

Schema — OPTIONAL
id string

Unique identifier for the test patient

email string

Auto-generated email address in format test-patient+[random]@[org-domain]

firstName string

First name of the test patient

lastName string

Last name of the test patient

dateOfBirth object — OPTIONAL

Date of birth in ISO format

organizationId string

ID of the organization this test patient belongs to

createdAt date-time

Timestamp when the test patient was created

isTestPatient boolean

Indicates this is a test patient

password string — OPTIONAL

New password if regeneratePassword was true or password was provided. Not included if password was not changed.