Skip to content

Aliases

AliasesService provides operations for managing aliases.

Base path: /aliases

ListAccountAliases lists all aliases (receiving addresses) for an account.

Request (ListAccountAliasesRequest)

FieldTypeDescription
account_idstring

Response (ListAccountAliasesResponse)

FieldTypeDescription
aliasesAlias[]

CreateAlias creates a new alias for an account (validates domain is configured).

Request (CreateAliasRequest)

FieldTypeDescription
account_idstringaccount_id: Account to create the alias for.
local_partstringlocal_part: The part before the @ sign (e.g. “support” for support@example.com).
domain_idstringdomain_id: Domain for the alias (must be a configured and verified sending domain).
is_activebool?is_active: If false, incoming mail to this alias will be rejected. Default true.
is_visiblebool?is_visible: If false, this alias will not appear in UI sender picker lists. Default true.
can_send_frombool?can_send_from: If true, this alias can be used as From address. Default false.
namestring?name: Display name shown in the From header (e.g. “Support Team”).
reply_tostring?reply_to: Override Reply-To address for outgoing mail sent from this alias.
bccstring?bcc: Address added as BCC on every email sent from this alias.

Response (CreateAliasResponse)

FieldTypeDescription
aliasAlias

UpdateAlias updates alias properties (IsActive, IsVisible).

Request (UpdateAliasRequest)

FieldTypeDescription
alias_idstringalias_id: The alias to update.
is_activebool?is_active: Set to false to stop accepting mail to this alias.
is_visiblebool?is_visible: Set to false to hide this alias from UI sender picker lists.
can_send_frombool?can_send_from: Update whether this alias can be used as a From address.
namestring?name: Update the From header display name.
reply_tostring?reply_to: Update the override Reply-To address.
bccstring?bcc: Update the always-BCC address.

Response (UpdateAliasResponse)

FieldTypeDescription
aliasAlias

DeleteAlias deletes an alias (can delete primary aliases).

Request (DeleteAliasRequest)

FieldTypeDescription
alias_idstring

Response (DeleteAliasResponse)

No fields.