BaseCorrespondenceExt

Description of the properties for the object

Link to BaseCorrespondenceExt

Represents a request object for the operation, InitializeCorrespondence, that can create a correspondence in Altinn.

resourceId

Type: string

The ID for the resource associated with the correspondence

sender

Type: string

The sender of the correspondence.

sendersReference

Type: string

Used by senders and receiver to identify a specific Correspondence using external identification methods.

messageSender

Type: string?

An alternative name for the sender of the correspondence. The name will be displayed instead of the organization name.

content

Type: InitializeCorrespondenceContentExt

The correspondence content. Contains information about the title, body, etc.

requestedPublishTime

Type: DateTimeOffset?

When the correspondence should become visible to the recipient. If value is set to null during initialization, the correspondence is published immediately.

allowSystemDeleteAfter

Type: DateTimeOffset?

The date for when Altinn can remove the correspondence from its database

dueDateTime

Type: DateTimeOffset?

The date and time for when the recipient must reply/confirm.

externalReferences

Type: List<ExternalReferencesExt>?

A list of references senders can use to tell the recipient that the correspondence is related to the referenced item(s). Examples include Altinn App instances, Altinn Broker file transfers.

propertyList

Type: Dictionary<string, string>

User-defined properties related to the Correspondence.

replyOptions

Type: List<CorrespondenceReplyOptions>

Options for how the recipient can reply to the correspondence by accessing one or more URLs.

notification

Type: InitializeCorrespondenceNotificationExt?

Notifications directly related to the correspondence

ignoreReservation

Type: bool?, false if not specified otherwise

Specifies whether the correspondence can override reservation against digital communication in the Contact and Reservation Register (KRR)

published

Type: DateTimeOffset?

The date and time of which the correspondence was published. This value is set automatically after the correspondence has been published.

isConfirmationNeeded

Type: bool?, false if not specified otherwise

Specifies whether the recipient must confirm the correspondence have been read. If confirmation is needed and the recipient has not confirmed the correspondence within the due date, this will result in the event CorrespondenceRecipientNeverConfirmed being published.