Skip to content
Upvio Developer Docs

Patient Archived

POST

Sent when a patient is archived. Archived patients are hidden from the dashboard but are not deleted.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required

Unique identifier for this event delivery.

string
name
required

The name of the event, in resource.action format.

string
Allowed value: patient.archive
createdAt
required

When the event was recorded by Upvio.

string format: date-time
business
required

The business the event belongs to.

object
id
required

Unique identifier across the Upvio platform.

string
data
required

The archival state of a patient.

object
id
required

Unique identifier across the Upvio platform.

string
businessId
required

The business this patient belongs to.

string
archivedAt
Any of:

ISO 8601 timestamp.

string format: date-time
archivedReason
string | null

Responses

Section titled “Responses”

200

Section titled “200”

Return any 2xx status code to acknowledge the delivery.