Aliases
AliasesService provides operations for managing aliases.
Base path: /aliases
POST /aliases/ListAccountAliases
Section titled “POST /aliases/ListAccountAliases”ListAccountAliases lists all aliases (receiving addresses) for an account.
Request (ListAccountAliasesRequest)
| Field | Type | Description |
|---|---|---|
account_id | string |
Response (ListAccountAliasesResponse)
| Field | Type | Description |
|---|---|---|
aliases | Alias[] |
POST /aliases/CreateAlias
Section titled “POST /aliases/CreateAlias”CreateAlias creates a new alias for an account (validates domain is configured).
Request (CreateAliasRequest)
| Field | Type | Description |
|---|---|---|
account_id | string | account_id: Account to create the alias for. |
local_part | string | local_part: The part before the @ sign (e.g. “support” for support@example.com). |
domain_id | string | domain_id: Domain for the alias (must be a configured and verified sending domain). |
is_active | bool? | is_active: If false, incoming mail to this alias will be rejected. Default true. |
is_visible | bool? | is_visible: If false, this alias will not appear in UI sender picker lists. Default true. |
can_send_from | bool? | can_send_from: If true, this alias can be used as From address. Default false. |
name | string? | name: Display name shown in the From header (e.g. “Support Team”). |
reply_to | string? | reply_to: Override Reply-To address for outgoing mail sent from this alias. |
bcc | string? | bcc: Address added as BCC on every email sent from this alias. |
Response (CreateAliasResponse)
| Field | Type | Description |
|---|---|---|
alias | Alias |
POST /aliases/UpdateAlias
Section titled “POST /aliases/UpdateAlias”UpdateAlias updates alias properties (IsActive, IsVisible).
Request (UpdateAliasRequest)
| Field | Type | Description |
|---|---|---|
alias_id | string | alias_id: The alias to update. |
is_active | bool? | is_active: Set to false to stop accepting mail to this alias. |
is_visible | bool? | is_visible: Set to false to hide this alias from UI sender picker lists. |
can_send_from | bool? | can_send_from: Update whether this alias can be used as a From address. |
name | string? | name: Update the From header display name. |
reply_to | string? | reply_to: Update the override Reply-To address. |
bcc | string? | bcc: Update the always-BCC address. |
Response (UpdateAliasResponse)
| Field | Type | Description |
|---|---|---|
alias | Alias |
POST /aliases/DeleteAlias
Section titled “POST /aliases/DeleteAlias”DeleteAlias deletes an alias (can delete primary aliases).
Request (DeleteAliasRequest)
| Field | Type | Description |
|---|---|---|
alias_id | string |
Response (DeleteAliasResponse)
No fields.