Create Patient Subscriptions

Adds subscriptions for a single patient.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Particle Patient ID

Body Params

Subscriptions

subscriptions
array of objects
required
length ≥ 1
subscriptions*
string

Optional. Name of the Monitoring Plan to enroll the patient on, as configured for your organization or provided by Particle for all organizations (for example ACTIVE or PASSIVE); your organization's plans are checked first. Matched case-insensitively. When omitted, the patient is enrolled on your organization's default plan. If no plan with this name exists for your organization or among Particle's shared plans, an individual-patient request is rejected with HTTP 404, while a cohort request returns HTTP 200 with a per-patient error; both use error code MONITORING_PLAN_NOT_FOUND. Only applies to subscription type MONITORING.

string

Required when creating subscriptions for multiple patients (POST /patients/subscriptions). Ignored on the per-patient endpoints, which take the patient from the path.

string
string
required

The subscription type.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json