Send email with file references

How to send composed email orders with file references through the Composed Notifications API.

When you test and monitor composed email orders, you can look up detailed descriptions of order and notification status values in the reference for status values for orders and notifications.

Prerequisites

Before you start, ensure that you have:

1. A Maskinporten client with scope altinn:serviceowner/notifications.composedemail.create
2. An Altinn token for API authentication
3. Files uploaded to Azure Blob Storage
4. A SAS URL for each file you want to include as an attachment

API endpoint

Altinn Notifications offers one endpoint for composed email orders:

Base URL:

• Test (TT02): https://platform.tt02.altinn.no/notifications/api/v1
• Production: https://platform.altinn.no/notifications/api/v1

Send composed email order

Request structure

{
  "idempotencyId": "string",
  "sendersReference": "string (optional)",
  "requestedSendTime": "2026-07-01T10:00:00Z",
  "recipient": {
    "emailAddress": "string",
    "emailSettings": {
      "subject": "string",
      "body": "string",
      "contentType": "Plain",
      "attachments": [
        {
          "filename": "string",
          "mimeType": "string",
          "sasUrl": "https://..."
        }
      ]
    }
  }
}

Fields

idempotencyId (required)

• Type: String
• Description: Unique identifier for this sending. Used to ensure that the same message is not sent multiple times upon repeated requests.
• Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

sendersReference (optional)

• Type: String
• Description: Your own reference for this sending. Used for logging and tracking.
• Example: "ref-2026-001"

requestedSendTime (optional)

• Type: DateTime (UTC)
• Description: Requested send time for the notification order.
• Example: "2026-07-01T10:00:00Z"

emailAddress (required)

• Type: String
• Description: Recipient’s email address.
• Example: "recipient@example.com"

subject (required)

• Type: String
• Description: Email subject line.
• Example: "Decision regarding your application"

body (required)

• Type: String
• Description: Email body content.
• Example: "Please review the attached decision document."

contentType (optional)

• Type: String
• Values: "Plain" or "Html"
• Default: "Plain"
• Description: Content type for the email body.

attachments (optional)

• Type: Array
• Description: List of file references to include as email attachments. If omitted, null, or empty, the email is sent without attachments.

filename (required when attachment is provided)

• Type: String
• Description: Attachment filename.
• Validation: Must not include path separators (/, \) and must include a file extension.
• Example: "decision.pdf"

mimeType (required when attachment is provided)

• Type: String
• Description: MIME type for the attachment.
• Validation: Must be supported by Azure Communication Services.
• Example: "application/pdf"

sasUrl (required when attachment is provided)

• Type: String (absolute URI)
• Description: SAS URL used by the API to retrieve the file at send time.
• Example: "https://youraccount.blob.core.windows.net/container/decision.pdf?se=...&sp=r&sr=b&sig=..."

Validation requirements

SAS URL requirements

Each attachment SAS URL is validated at the API boundary:

Attachment requirements

Example: Send composed email with attachment

curl -X POST "https://platform.tt02.altinn.no/notifications/api/v1/future/orders/composed-email" \
  -H "Authorization: ******" \
  -H "Content-Type: application/json" \
  -d '{
    "idempotencyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sendersReference": "ref-2026-001",
    "requestedSendTime": "2026-07-01T10:00:00Z",
    "recipient": {
      "emailAddress": "recipient@example.com",
      "emailSettings": {
        "subject": "Decision regarding your application",
        "body": "Please review the attached decision document.",
        "contentType": "Plain",
        "attachments": [
          {
            "filename": "decision.pdf",
            "mimeType": "application/pdf",
            "sasUrl": "https://youraccount.blob.core.windows.net/container/decision.pdf?se=2026-07-01T12%3A00%3A00Z&sp=r&sr=b&sig=..."
          }
        ]
      }
    }
  }'

Response

On successful registration, you receive 201 Created with tracking identifiers:

{
  "notificationOrderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "notification": {
    "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sendersReference": "ref-2026-001"
  }
}

If you send the same request again with the same idempotencyId, the API returns 200 OK with the same response content.

Error handling

Possible error codes:

Next steps

• API reference
• OpenAPI specification