Attach a message API

Use this service to attach text messages to an existing application

---

Version and Status

---

Overview

The Attach a message API allows users to attach text messages to an existing application. The Notifications API can then be used to understand if the message has been successfully attached to the application.

If users want to attach a document to an application, they will need to use the Attach a document API.

View the technical guide

Technical guide

View the API specification

Web version (opens in new tab)

How the API works

This diagram demonstrates how the Attach a message API works to support users.

When a user submits a message, the HMLR system will initially respond with an empty ‘202 Accepted’ response. Users will then receive a notification stating whether the attached message has been successful or not.

How to test this API

HMLR has created a test environment for the Attach a message API. We’ve also provided example code to demonstrate what you should expect when developing your own services.

View Attach a message API test stubs

Please note there are also plans to release a sandbox test environment for developers in the future. The exact release date is to be confirmed.

For general testing guidance, visit our guide to testing.