Message Batches (v0.0.1)

Represents a single batch, containing multiple messages.

Overview

Batch of messages sent to the NHS Notify Batch endpoint

Entity Properties

Name Type Required Description
idIntegerRequiredUnique identifier for the batch
batch_idstringOptionalIdentifier created by NHS Notify
batch_referenceUUIDRequiredUnique identifier for batch instance
created_attimestampRequiredDatetime stamp for batch creation
statusstringRequiredCurrent status of the batch
detailsstringOptionalHTTP payload of the information in the batch
responsestringOptionalHTTP response from NHS Notify

Relationships

Examples