---
title: Email Template Entity
url: https://docs.kaltura.com/docs/events-collaboration/messaging-api/messaging-email-template-entity
---

## Email Template Entity

Every email template has this structure:

| Field | Type | Description |
|-------|------|-------------|
| `id` | string | Auto-generated unique identifier (read-only) |
| `partnerId` | integer | Partner ID extracted from KS (read-only) |
| `appGuid` | string | App Registry GUID this template belongs to |
| `name` | string | Template display name |
| `description` | string | Template description |
| `subject` | string | Email subject line (supports token references) |
| `body` | string | Email HTML body (supports token references) |
| `msgParamsMap` | object | Token definitions — maps token names to their types |
| `toAttributePath` | string | Token expression that resolves to the recipient email (e.g., `{recipient.email}`) |
| `from` | string | Sender email address |
| `fromName` | string | Sender display name (supports token references) |
| `cc` | string | CC email address |
| `bcc` | string | BCC email address |
| `unsubscribeGroups` | string[] | Unsubscribe group IDs for CAN-SPAM compliance |
| `status` | string | `enabled`, `disabled`, or `deleted` |
| `templateType` | string | Always `"email"` |
| `adminTags` | string | Comma-separated tags for filtering |
| `customHeaders` | object | Custom email headers (key-value pairs) |
| `numberOfTokenUsed` | integer | Number of tokens in the template (read-only) |
| `version` | integer | Auto-incrementing version number (read-only) |
| `emailProviderId` | string | Assigned email provider (read-only) |
| `createdAt` | string | ISO 8601 timestamp, e.g. `"2026-04-09T04:56:27.940Z"` (read-only) |
| `updatedAt` | string | ISO 8601 timestamp, e.g. `"2026-04-09T04:56:27.940Z"` (read-only) |
