Skip to main content
POST
/
user
/
patient
/
archive
Change Patient Archived Status
curl --request POST \
  --url https://api.decodahealth.com/user/patient/archive \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "patientIds": [
    "<string>"
  ],
  "isArchived": true
}
'
true

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Body

application/json
​
patientIds
string[]
required
​
isArchived
boolean
default:true

Response

Successful Response

The response is of type boolean.