> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentlinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview notification email

> Render a sample transactional email without sending it or reading customer events.

`preview_notification_email`

Render a sample transactional email without sending it or reading customer events.

<Note>Available in the deployed MCP and HTTP bundle. Confirm access and inputs with your connected catalog. Workspace scopes and enabled providers still apply.</Note>

| Access        | Behavior         |
| ------------- | ---------------- |
| `events:read` | Reads saved data |

This read does not start a verification job.

## Example request

Connect through [MCP](/guides/connect-mcp), [CLI](/guides/connect-cli), or [HTTP](/guides/connect-http). Replace example identifiers with records from your workspace.

<CodeGroup>
  ```json MCP theme={null}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "preview_notification_email",
      "arguments": {}
    }
  }
  ```

  ```bash CLI theme={null}
  agentlinkops call preview_notification_email --args '{}'
  ```

  ```bash HTTP theme={null}
  curl "$AGENTLINKOPS_API_URL/v1/commands/preview_notification_email" \
    -H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
    -H 'Content-Type: application/json' \
    --data '{}'
  ```
</CodeGroup>

## Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in `structuredContent` and in a text content block; generic HTTP and CLI return the JSON result directly.

```json theme={null}
{
  "html": "<!DOCTYPE html><html lang=\"en\"><body>Example workspace: website updates</body></html>",
  "text": "Example workspace: website updates",
  "sample": true
}
```

## Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

This operation accepts an empty object.

### Validation and omitted values

Renders example content only. No customer events are read and no email is sent.

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) explain evidence states, empty lists and extensions.

| Field    | Type    | Presence | Meaning and constraints                                                                 |
| -------- | ------- | -------- | --------------------------------------------------------------------------------------- |
| `html`   | string  | Required |                                                                                         |
| `text`   | string  | Required |                                                                                         |
| `sample` | boolean | Required | True: the rendered preview uses example content, never customer events. must equal true |

[Download input schema](/schemas/preview_notification_email.input.json) · [Download output schema](/schemas/preview_notification_email.output.json)

## Errors and retries

The command is annotated idempotent. Reuse an accepted idempotency key when the input provides one; changing the payload under a reused key can conflict.

See [error recovery](/reference/errors) for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

## HTTP resource routes

This operation has no separate resource alias. Use its generic command route in a matching environment.

## Continue

[save\_notification\_preferences](/reference/commands/save_notification_preferences)

Follow the [related workflow](/guides/connect-http), inspect [capability status](/capability-status), or return to the [command index](/reference/index).
