Skip to main content
POST
/
api
/
v2
/
patients
cURL
curl --request POST \
  --url https://app.spotdx.com/api/v2/patients/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "Alice",
  "last_name": "Smith",
  "email": "[email protected]",
  "sex": "F",
  "date_of_birth": "2023-12-25",
  "phone": "1234567890"
}
'
{
  "first_name": "Alice",
  "last_name": "Smith",
  "email": "[email protected]",
  "sex": "F",
  "date_of_birth": "2023-12-25",
  "phone": "1234567890"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

​
first_name
string
required

The first name of the patient.

Example:

"Alice"

​
last_name
string
required

The last name of the patient to be created.

Example:

"Smith"

​
email
string<email>
required

The email of the patient to be created.

Example:

"[email protected]"

​
sex
enum<string>
required

The biological sex of the patient to be created.

Available options:
M,
F
Example:

"F"

​
date_of_birth
string<date>
required

The date of birth of the patient to be created.

​
phone
string

Optional phone number of the patient.

Example:

"1234567890"

Response

​
first_name
string
required

The first name of the patient.

Example:

"Alice"

​
last_name
string
required

The last name of the patient to be created.

Example:

"Smith"

​
email
string<email>
required

The email of the patient to be created.

Example:

"[email protected]"

​
sex
enum<string>
required

The biological sex of the patient to be created.

Available options:
M,
F
Example:

"F"

​
date_of_birth
string<date>
required

The date of birth of the patient to be created.

​
phone
string

Optional phone number of the patient.

Example:

"1234567890"