POST
/
api
/
v2
/
kits
/
{public_id}
/
curl --request POST \
  --url https://app.spotdx.com/api/v2/kits/{public_id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {}
}'
{
  "events": [
    {
      "created": "2023-01-01T04:30:11.222Z",
      "status": "preparing"
    },
    {
      "created": "2023-01-05T04:30:11.222Z",
      "status": "in_transit"
    },
    {
      "created": "2023-01-06T04:30:11.222Z",
      "status": "delivered"
    },
    {
      "created": "2023-01-07T04:30:11.222Z",
      "status": "registered"
    }
  ],
  "kit_id": "SPOT123456",
  "registered_to": {
    "date_of_birth": "1990-01-01",
    "email": "alice123@gmail.com",
    "first_name": "Alice",
    "last_name": "Smith",
    "patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
    "phone": "1234567890",
    "sex": "F"
  },
  "sample": {
    "events": [
      {
        "created": "2023-01-01T04:30:11.222Z",
        "status": "awaiting_collection"
      },
      {
        "created": "2023-01-10T04:30:11.222Z",
        "status": "in_transit"
      },
      {
        "created": "2023-01-11T04:30:11.222Z",
        "status": "delivered"
      },
      {
        "created": "2023-01-12T04:30:11.222Z",
        "status": "received"
      },
      {
        "created": "2023-01-13T04:30:11.222Z",
        "status": "resulted"
      }
    ],
    "panels": [
      "PANEL-123"
    ],
    "reports": [
      {
        "date_collected": "2023-11-07T05:31:56Z",
        "date_received": "2023-11-07T05:31:56Z",
        "date_resulted": "2023-11-07T05:31:56Z",
        "is_amendment": true,
        "pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
        "report_id": "<string>",
        "results": [
          {
            "comments": null,
            "name": "HDL Cholesterol",
            "range_maximum": 200,
            "range_minimum": 20,
            "result": 123,
            "result_type": "quantity",
            "time_collected": "2023-01-14T04:30:11.222Z",
            "unit_of_measure": "mg/dL"
          },
          {
            "comments": null,
            "name": "Vitamin B12",
            "range_maximum": 200,
            "range_minimum": 20,
            "result": "<10",
            "result_type": "quantity",
            "time_collected": "2023-01-14T04:30:11.222Z",
            "unit_of_measure": "pg/mL"
          },
          {
            "comments": null,
            "name": "Chlamydia",
            "range_maximum": null,
            "range_minimum": null,
            "result": "negative",
            "result_type": "reactivity",
            "time_collected": "2023-01-14T04:30:11.222Z",
            "unit_of_measure": null
          },
          {
            "comments": null,
            "name": "rs1234567",
            "range_maximum": null,
            "range_minimum": null,
            "result": "TT",
            "result_type": "genotype",
            "time_collected": "2023-01-14T04:30:11.222Z",
            "unit_of_measure": null
          }
        ],
        "txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"
      }
    ],
    "sample_id": "SPOT654321",
    "shipments": [
      {
        "carrier": "usps",
        "created": "2023-01-01T04:30:11.222Z",
        "tracking_number": "9400123456789999876500"
      }
    ],
    "status": "awaiting_collection",
    "type": "adx100"
  },
  "shipment_to_customer": {
    "carrier": "usps",
    "created": "2023-01-01T04:30:11.222Z",
    "tracking_number": "9400123456789999876500"
  },
  "status": "preparing",
  "type": "health_kit_1"
}

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Path Parameters

public_id
string
required

ID of the kit to update.

Body

application/json
metadata
object
required

Metadata to be associated with the kit.

Response

200 - application/json
events
object[]

A list of all the events that have occurred for this kit.

kit_id
string

The unique identifier of the kit.

registered_to
object
sample
object
shipment_to_customer
object
status
enum<string>

The new status of the kit.

Available options:
preparing,
in_transit,
delivered,
delivery_exception,
registered,
canceled
type
string

The kit's type