Create a MESH mailbox subscription

Learn how to create a Multicast Notification Service subscription using a MESH mailbox.

Creating a MESH mailbox subscription

Prerequisite

To create a MESH subscription, you must already have a MESH mailbox.

Apply for a MESH mailbox

Create the MESH subscription

Create a subscription using the example. Make sure you add your MESH mailbox in the channel.endpoint.

Note: For MESH subscriptions, there is no confirmation step.

Create the subscription using the MNS API

Create the subscription using the service API. You can do this using code, Postman, curl, or a similar tool.

POST /multicast-notification-service/subscriptions HTTP/1.1
Host: int.api.service.nhs.uk
Content-Type: application/fhir+json
X-Correlation-ID: {UUID}
Authorization: Bearer {ACCESS TOKEN}



{
    "resourceType": "Subscription",
    "status": "requested",
    "reason": "A good descriptive reason for the subscription, useful in future to help track down subscribers",
    "criteria": "eventType=mns-test-signal-1",
    "channel": {
        "type": "message",
        "endpoint": "mesh://MYMAILBOXOT101?workflow_id=myWorkflow101",
        "payload": "application/fhir+json"
    }
}

Notes

This is a FHIR request, and the Content-Type header must be set to application/fhir+json. However, the channel.payload value specifies the format of the event you receive (CloudEvent or FHIR).

For internal subscribers, channel.payload specifies the format you want to receive:

Send application/json for CloudEvent
Send application/json+fhir for FHIR R4 format

Last edited: 28 October 2026 3:15 pm