api

Activate a kit via API by either providing 'patient_id' or the information needed to create a new patient. Please note that the activation API is only available for selected kits.

post/api/v3/kits/{public_id}/activate/

Request

  • Base URL: https://app.spotdx.com
  • URL: https://app.spotdx.com/api/v3/kits/{public_id}/activate/
  • Auth: one of:
    • API key in header Authorization
    • none

Path parameters

public_idstring required

Query parameters

public_idstring required

Public ID of the kit

Request body

patient_idstring

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

first_namestring
last_namestring
date_of_birthstring date
sexstring
street1string
street2string
citystring
statestring
zipstring
emailstring email
phonestring
research_consentboolean

Response

Example response

{
  "data": {
    "result": "success"
  }
}

Changes

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