POST
/
api
/
v3
/
kits
/
{public_id}
/
activate
curl --request POST \
  --url https://app.spotdx.com/api/v3/kits/{public_id}/activate/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "patient_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "sex": "<string>",
  "street1": "<string>",
  "street2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "research_consent": true
}'
{
  "data": {
    "result": "success"
  }
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
public_id
string
required

Query Parameters

​
public_id
string
required

Public ID of the kit

Body

application/json

Provide 'patient_id' to activate the kit for an existing patient, or provide patient details to create a new patient. Individual field requirements depend on the kit type being activated. Please note that the activation API is only available for selected kits.

​
patient_id
string

ID of the existing patient. If provided, no other patient details are needed.

​
first_name
string
​
last_name
string
​
date_of_birth
string
​
sex
string
​
street1
string
​
street2
string
​
city
string
​
state
string
​
zip
string
​
email
string
​
phone
string
​
research_consent
boolean

Response

200
application/json

Unspecified response body

​
data
object