A notification sent to a person or organisation during estate administration — beneficiary notifications, executor appointments, probate grants, document requests

Required fields
idnotificationTyperecipientTyperecipientIdchannelsentAt

Fields

FieldTypeReqDescription
channelenumThe communication channel used
idstringUnique identifier for this notification
notesstringAdditional notes about this notification
notificationTypeobjectThe type of notification sent
provenanceProvenanceConsolidated provenance metadata — how this entity was created, by whom, and whether a human has verified it
recipientIdstringReference to the Person.id or Organisation.id of the recipient
recipientIdDisplaystringHuman-readable display name for the referenced recipient
recipientTypeenumWhether the recipient is a person or an organisation
sentAtstringWhen the notification was sent
statusenumCurrent delivery status
templateIdstringIdentifier of the notification template used
email
post
phone
sms
in_app
other
person
organisation
pending
sent
delivered
failed
bounced

Get in touch

Have feedback on the schema reference? We'd love to hear from you.

Subject: Schema Reference Feedback