---
title: "API for HIP to send SMS notifications to patients"
method: POST
path: "/v0.5/patients/sms/notify"
tags: ["Gateway"]
---

# API for HIP to send SMS notifications to patients

`POST /v0.5/patients/sms/notify`

API to send SMS notifications to patient with custom deeplink.

## Headers

- `Authorization` string, required
- `X-CM-ID` string, required

## Request body

- PatientSMSNotifcationRequest
  - `notification` object, required
    - `careContextInfo` string, required — Information about care context or visit for which the SMS is being sent.
    - `deeplinkUrl` string, uri — A link pointing to digital health records of the patient. PHR App's deeplink will be sent in SMS if this field is not provided.
    - `hip` object, required
      - `id` string, required — Registered id of the HIP.
      - `name` string — Name of the HIP(Hospital). Hospital's name will be fetched from registry if not provided.
    - `phoneNo` string, required — Phone number of the receiver with country code
    - `receiverName` string — Name of the reciever/patient. Receiver's name will not be sent if not provided.
  - `requestId` string, uuid, required — a nonce, unique for each HTTP request
  - `timestamp` string, date-time, required — Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

## Response `202`

accepted

## Other responses

- `400` — **Causes:** * required information not provided
- `401` — **Causes:** * Unauthorized request
- `500` — **Causes:** * Downstream system(s) is down. * Unhandled exceptions.

---

[API](https://skmtc.net/ndhm/apis/ndhm-hip.md) · [All operations](https://skmtc.net/ndhm/apis/ndhm-hip/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ndhm/ndhm-hip/versions/26beb7157b70/schema)