Create alias
create_aliasCreate a new email alias. Pass local_part for a custom address (format defaults to "custom" when it is given), or omit it to auto-generate a random local part. Labels and notes cannot be set here (they are vault-encrypted client-side); the user can edit them from the anon.li web UI.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | Domain for the alias: 'anon.li' (default) or one of the user's verified custom domains | anon.li |
| format | No | 'custom' uses `local_part`; 'random' generates the local part. Defaults to 'custom' when `local_part` is given, otherwise 'random'. | |
| local_part | No | The address before the @ for a custom alias. Lowercase letters and numbers, with single dots as separators (e.g. 'jane.doe'); no leading, trailing, or consecutive dots. Not allowed with format 'random'. | |
| recipient_ids | No | Recipient IDs to forward to. If omitted (and no recipient_email), uses the default recipient. Not allowed together with recipient_email. | |
| recipient_email | No | Alternative to recipient_ids: an existing verified recipient email address. Not allowed together with recipient_ids. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| Yes | |||
| active | Yes | ||
| created_at | Yes | ||
| updated_at | Yes |