DigitalLetterUnsuccessful Data

Data payload of the DigitalLetterUnsuccessful event

Known Issues / Todo

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

Full Screen

DigitalLetterUnsuccessful Data

Data payload of the DigitalLetterUnsuccessful event

Schema Information

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

Properties

`messageReference`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/messageReference

`senderId`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/senderId

`failureCode`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/core.schema.json#/properties/failureCode

`failureReason`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/core.schema.json#/properties/failureReason

Required Fields

messageReference
senderId
failureCode
failureReason

Additional Properties

Additional properties are not allowed.

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-queue-digital-letter-unsuccessful-data.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: DigitalLetterUnsuccessful Data
description: Data payload of the DigitalLetterUnsuccessful event
type: object
additionalProperties: false
properties:
  messageReference:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/messageReference
  senderId:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/senderId
  failureCode:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/core.schema.json#/properties/failureCode
  failureReason:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/core.schema.json#/properties/failureReason
required:
- messageReference
- senderId
- failureCode
- failureReason