---
title: "Acknowledgment response for SMS notification sent to patient by HIP"
method: POST
path: "/v0.5/patients/sms/on-notify"
tags: ["patient notification"]
---

# Acknowledgment response for SMS notification sent to patient by HIP

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

If the SMS notification is successfully sent to patient then "status" will be "ACKNOWLEDGED" with no error.
If the SMS notification is failed then "status" will be "ERRORED" with error.

## Headers

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

## Request body

- PatientSMSNotifcationResponse
  - `error` Error
    - `code` 1000 | 10001, required
    - `message` string, required
  - `requestId` string, uuid, required — a nonce, unique for each HTTP request
  - `resp` RequestReference, required
    - `requestId` string, uuid, required — the requestId that was passed
  - `status` 'ACKNOWLEDGED' | 'ERRORED'
  - `timestamp` string, date-time, required — Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

## Response `202`

Request Accepted

## Other responses

- `400` — Invalid request, required attributes 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)