MESH data

Reusable types for NHS Notify payload schemas.

Known Issues / Todo

⛅ This page is draft and is subject to rapid change, and may not be fully accurate or complete

Full Screen

MESH data

Reusable types for NHS Notify payload schemas.

Schema Information

Schema ID: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json
Schema Version: https://json-schema.org/draft/2020-12/schema
Source File: digital-letters/2025-10-draft/defs/mesh.schema.yaml

Properties

`meshMessageId`

Type: string

Id of the message in the MESH inbox

Minimum length: 1 Examples: 20200601122152994285_D59900

`meshMailboxId`

Type: string

Id of the mailbox used to submit letter requests and receive acknowledgements

Minimum length: 1 Examples: MAILBOX01

`meshMailboxReportsId`

Type: string

Id of the mailbox used to receive daily reports

Minimum length: 1 Examples: MAILBOX02

`reportPeriodStartTime`

Type: string

Start time of the reporting period

Format: date-time Examples: 2025-12-03T00:00:00Z

`reportPeriodEndTime`

Type: string

End time of the reporting period

Format: date-time Examples: 2025-12-04T23:59:59Z

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: MESH data
description: Reusable types for NHS Notify payload schemas.
type: object
properties:
  meshMessageId:
    type: string
    minLength: 1
    description: Id of the message in the MESH inbox
    examples:
    - 20200601122152994285_D59900
  meshMailboxId:
    type: string
    minLength: 1
    description: Id of the mailbox used to submit letter requests and receive acknowledgements
    examples:
    - MAILBOX01
  meshMailboxReportsId:
    type: string
    minLength: 1
    description: Id of the mailbox used to receive daily reports
    examples:
    - MAILBOX02
  reportPeriodStartTime:
    type: string
    format: date-time
    description: Start time of the reporting period
    examples:
    - '2025-12-03T00:00:00Z'
  reportPeriodEndTime:
    type: string
    format: date-time
    description: End time of the reporting period
    examples:
    - '2025-12-04T23:59:59Z'