API Reference

Sender Addresses API

Endpoints for listing verified sender addresses.

Read-Only API

Sender addresses can only be created and managed in the ArtaMail dashboard. The API provides read-only access to view available addresses. To add sender addresses, first add and verify your domain, then create sender addresses with custom local parts.

GET/api/v1/sender-addresses

Get all verified sender addresses for your organization.

Example Request

Terminal

curl https://artamail.artatol.com/api/v1/sender-addresses \
  -H "Authorization: Bearer am_live_sk_xxx"

Response

json

[
  {
    "email": "[email protected]",
    "name": "Example App",
    "reply_to": "[email protected]",
    "is_default": true,
    "is_verified": true
  },
  {
    "email": "[email protected]",
    "name": "Example Billing",
    "reply_to": null,
    "is_default": false,
    "is_verified": true
  }
]

Sender Address Fields

Field	Type	Description
`email`	string	Sender email address
`name`	string \| null	Display name (shown as "Name <email>")
`reply_to`	string \| null	Reply-to address if different from sender
`is_default`	boolean	Whether this is the default sender
`is_verified`	boolean	Whether the address is verified in AWS SES

Using Sender Addresses

Use a sender address in your email by specifying the from field:

json

{
  "to": "[email protected]",
  "template": "welcome",
  "from": "[email protected]",
  "from_name": "Example Billing"
}

If no from is specified, the default sender address is used.

Default Address

Each organization has exactly one default sender address:

If from is not specified, the default address is used
If from is specified, it must match a verified address
Using an unverified address will result in an error

System Address

All organizations have access to the system sender address [email protected]. This can be used as a fallback when no custom addresses are configured.

Adding Custom Sender Addresses

To use custom sender addresses with your own domain:

1Add your domain in the dashboard under Settings → Sender Addresses → Domains tab
2Add the provided DNS records (TXT for domain verification, 3x CNAME for DKIM) to your DNS provider
3Wait for DNS propagation (typically 5-30 minutes) and click "Refresh Status"
4Once verified on both AWS accounts, create sender addresses using your domain

Dual Account Verification

Your domain must be verified on both AWS SES accounts (primary and secondary) before you can create sender addresses. This ensures reliable email delivery across our infrastructure.