Create a patient.

post/api/v2/patients/

Request

  • Base URL: https://app.spotdx.com
  • URL: https://app.spotdx.com/api/v2/patients/
  • Auth: API key in header Authorization

Request body

first_namestring required

The first name of the patient.

last_namestring required

The last name of the patient to be created.

emailstring email required

The email of the patient to be created.

phonestring

Optional phone number of the patient.

sex'M' | 'F' required

The biological sex of the patient to be created.

date_of_birthstring date required

The date of birth of the patient to be created.

Example request

{
  "first_name": "Alice",
  "last_name": "Smith",
  "email": "alice123@gmail.com",
  "phone": "1234567890",
  "sex": "F"
}

Response

first_namestring required

The first name of the patient.

last_namestring required

The last name of the patient to be created.

emailstring email required

The email of the patient to be created.

phonestring

Optional phone number of the patient.

sex'M' | 'F' required

The biological sex of the patient to be created.

date_of_birthstring date required

The date of birth of the patient to be created.

Example response

{
  "first_name": "Alice",
  "last_name": "Smith",
  "email": "alice123@gmail.com",
  "phone": "1234567890",
  "sex": "F"
}

Changes

No recorded changes to this operation across all 1 revision of this API.