List a mailer's Send As aliases
GET/v1/oauth/:mailer_id/aliases
Returns the extra addresses a Gmail mailer can send from, read from the mailbox's Gmail "Send mail as" settings. The mailer's own address is the top-level email and is always sendable; aliases lists only the other addresses. Use an alias with sendable: true as from.email on POST /v1/email/send with this mailer_id.
Rules:
- Only Google OAuth mailers connected for both sending and reading (
config_type: smtp_imap). Other mailers, including Microsoft, return 422. sendableis true when Gmail shows the alias as verified (status: accepted);pendingaliases are rejected on send until the owner verifies them in Gmail.- The list is stored on the mailer, re-read when the mailer connects or reconnects, and re-read from Gmail when it is older than 24 hours. Pass
refresh=trueto read it now, for example right after adding or verifying an alias.syncedAtis when it was last read.
Request
Path Parameters
mailer_id stringrequired
Mailer ID
Query Parameters
refresh boolean
Read Gmail now instead of returning the stored list
Responses
- 200
- 400
- 404
- 409
- 422
- 502
Send As aliases
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
aliases
object[]
default boolean
displayName string
email string
sendable boolean
status string
email string
mailerId string
success boolean
syncedAt string
{
"aliases": [
{
"default": false,
"displayName": "Acme Sales",
"email": "sales@acme.com",
"sendable": true,
"status": "accepted"
}
],
"email": "john@acme.com",
"mailerId": "oauth_smtp_imap_01JC3BBW8S9YGX2VNKG5MD7BTA",
"success": true,
"syncedAt": "2026-10-22T09:30:00Z"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
error string
success boolean
{
"error": "string",
"success": false
}
Mailer not found
- application/json
- Schema
- Example (from schema)
Schema
error string
success boolean
{
"error": "string",
"success": false
}
Mailer inactive
- application/json
- Schema
- Example (from schema)
Schema
error string
success boolean
{
"error": "string",
"success": false
}
Mailer type not supported, or mailer must be reconnected
- application/json
- Schema
- Example (from schema)
Schema
error string
success boolean
{
"error": "string",
"success": false
}
Gmail could not be read
- application/json
- Schema
- Example (from schema)
Schema
error string
success boolean
{
"error": "string",
"success": false
}
Loading...