# Route

The Route type of the TypeScript SDK, which routes.create and 3 more methods take or answer.

```ts
type Route = {
  address: string
  createdAt: number
  destinationType: ('mailbox' | 'webhook' | 'remote' | 'group')
  domain: string
  mailboxId: string | null
  memberCount?: number
  paced: boolean
  personaMailboxId?: string | null
  posting?: ('open' | 'members')
  remoteAddress: string | null
  webhookFormat: ('parsed' | 'reference') | null
  webhookUrl: string | null
}
```

## Fields

| Field | Type | Description |
| --- | --- | --- |
| `address` | `string` | Inbound email address (e.g. user@example.com) |
| `createdAt` | `number` | Creation timestamp in epoch seconds |
| `destinationType` | `('mailbox' \| 'webhook' \| 'remote' \| 'group')` | Destination type |
| `domain` | `string` | Domain part of the route address |
| `mailboxId` | `string` \| `null` | Target mailbox ULID when destinationType='mailbox', otherwise null |
| `memberCount` | `number` | Optional. Count of members in this group route |
| `paced` | `boolean` | True if inbound delivery to this route is rate-paced |
| `personaMailboxId` | `string` \| `null` | Optional. Group routes only: the ULID of the group's PERSONA — the address-less mailbox that keeps the group's archive (a copy of every message the group admits) and holds the credential that may send as the group address. Read it with GET /identities/:id (which reports groupAddress back). Null only while the group's delete is in flight |
| `posting` | `('open' \| 'members')` | Optional. Group posting policy (open = anyone may post, members = only members may post) |
| `remoteAddress` | `string` \| `null` | Where this address forwards a copy: the destination address when destinationType='remote', otherwise the forward TAP — an address that receives a copy alongside the destination. Null when neither is set |
| `webhookFormat` | `('parsed' \| 'reference') \| null` | Payload format for the webhook named by webhookUrl: 'parsed' (the default — decoded bodies and inlined attachments) or 'reference' (headers plus rawUrl, no MIME walk). Null when this address carries no webhook |
| `webhookUrl` | `string` \| `null` | Target webhook URL or tap webhook URL, otherwise null |

## Used by

| Method | What it does |
| --- | --- |
| [`routes.create`](/docs/sdks/typescript/routes/create) | Create a routing rule |
| [`routes.list`](/docs/sdks/typescript/routes/list) | List routing rules |
| [`routes.get`](/docs/sdks/typescript/routes/get) | Get email route details |
| [`routes.update`](/docs/sdks/typescript/routes/update) | Update email route |
