Configure email domains and sender identities from the CLI.

Email Identity

AscendKit email configuration has two layers:

  • A verified sending domain
  • One or more verified sender identities on that domain

The CLI uses the same backend APIs as the portal. Domain setup, identity management, status refresh, default sender selection, and test sends all map to the /api/email/settings backend routes.

View current email settings

ascendkit email-identity settings
ascendkit email-identity settings --json

By default this prints a compact summary of the configured domain, DNS provider, default sender, and sender identities. Use --json to print the full backend payload.

Set up a custom domain

ascendkit email-identity setup-domain yourapp.com
ascendkit email-identity status
  • setup-domain creates the SES domain identity and returns the DNS records you need to add.
  • status checks the SES domain status and public DNS records together.

To remove the custom domain and reset the environment back to the AscendKit sender:

ascendkit email-identity remove-domain

Manage sender identities

List identities and refresh their SES verification state:

ascendkit email-identity list

Add a new identity:

ascendkit email-identity add [email protected] --display-name "Your App"

Update the display name for an existing identity:

ascendkit email-identity update [email protected] --display-name "New Name"

Request SES to resend inbox verification:

ascendkit email-identity resend [email protected]

Set the default sender identity:

ascendkit email-identity set-default [email protected] --display-name "Your App"

Remove an identity:

ascendkit email-identity remove [email protected]

Send a test email from a verified identity:

ascendkit email-identity test [email protected] --to [email protected]

DNS provider shortcuts

Detect the DNS provider for the configured domain and print the provider console URL:

ascendkit email-identity open-dns

You can also detect a provider for a specific domain:

ascendkit email-identity open-dns --domain yourapp.com

Email suppressions

email-suppression list shows every address currently excluded from campaign delivery in the active environment. That includes SES-style suppressions (bounce, complaint) and user opt-outs (unsubscribe).

List excluded addresses for the current environment:

ascendkit email-suppression list
ascendkit email-suppression list --reason unsubscribe
ascendkit email-suppression list --skip 0 --limit 50
FlagDescription
--reasonFilter to bounce, complaint, or unsubscribe
--skipPagination offset (default 0)
--limitNumber of rows to return (default 100, max 500)

Remove a bounce or complaint suppression entry manually:

ascendkit email-suppression remove [email protected]

remove only applies to bounce and complaint suppressions. Unsubscribed users remain excluded until they opt back in through application logic or a future resubscribe flow.

Campaigns automatically exclude all of these addresses from delivery.