Skip to main content

Create a test patient

Creates a new test patient for the organization with an auto-generated email address in the format test-patient+{random}@{org-domain} and a secure auto-generated password. The organization must have a valid domain configured.

Path Parameters
orgId string REQUIRED

Organization ID

Request Body REQUIRED

Optional patient details. If not provided, defaults to firstName='Test' and lastName='Patient'

firstName string

First name of the test patient. Defaults to 'Test' if not provided.

lastName string

Last name of the test patient. Defaults to 'Patient' if not provided.

dateOfBirth string

Date of birth in ISO format (YYYY-MM-DD)

Responses
201

Test patient created successfully. The password is only returned once at creation time.

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

Auto-generated password. This is only returned once at creation time and cannot be retrieved later.