Create Subscriptions for multiple Patients

Subscribe a batch of patients to Signal monitoring in a single API call.

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

Subscribe multiple patients to Signal monitoring in a single request. Each patient must already be registered via the Patients API. Each entry in the subscriptions array requires a particle_patient_id and a subscription type.

For the full subscription workflow including single-patient options, see Subscribing Patients to Signal.

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