notification_collection

Schedule-push-notification - internal

Schedules a push notification to a person for a given time, for example a medication reminder.

POST/api/notification/schedule-push-notification

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

patient_idstringRequired

push_notification_dataobjectRequired

push_notification_data.healthIdstringRequired

push_notification_data.targetstringRequired

push_notification_data.titlestringRequired

push_notification_data.bodystringRequired

push_notification_data.timestampstringRequired

push_notification_data.paramsobjectRequired

push_notification_data.params.orderIdstringRequired

timestamp_to_pushstringRequired

medical_remainder_idstringRequired

Responses

500

Example values, scrubbed.

Error codes for this module

Schedule-push-notification - internal

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/notification/schedule-push-notification \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "patient_id": "<PATIENT_ID>",
  "push_notification_data": {
    "healthId": "<ABHA_ADDRESS>",
    "target": "TELECONSULTATION",
    "title": "Doctor Consultation",
    "body": "You have a doctor booking for Dr Nithish at 09.00 am today.",
    "timestamp": "2026-04-15T12:30:45.123Z",
    "params": {
      "orderId": "001"
    }
  },
  "timestamp_to_push": "2026-04-15T18:30:00",
  "medical_remainder_id": "01"
}'

{
  "code": "ABDM-9999: ",
  "message": "400 BAD_REQUEST \"Required header 'ABHA-ADDRESS' is not present.\""
}

Generated from the schema. The values are placeholders, not a captured response.