Skip to main content
PATCH
You can only update an order while its low-level status is ordered or awaiting_registration.

Authorizations

x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

order_id
string<uuid>
required

Your Order ID.

Body

application/json

Patch body for updating a modifiable order's scheduled activation date.

activate_by
string<date> | null
required

The date on which the order should be activated (dispatched to the lab). Must be today or a future date. Set to null to clear an existing scheduled date and dispatch the order immediately. Note: an order originally created for immediate processing (no activate_by at creation time) cannot be rescheduled — only orders that were created with an activate_by can have it changed or cleared.

Response

Successful Response

order
ClientFacingOrder · object
required
Example:
status
string
required
message
string
required