Mail aliases
Aliases of the organization's hosted mailboxes (scope: mailboxes:read)
GET
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
mailbox_id?stringOnly the aliases of this mailbox
Format
uuidOK
application/json- response
data*array<>meta?error*nullcurl -X GET "https://example.com/mail-aliases"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "address": "user@example.com", "mailbox_id": "4d23d1af-2eef-4598-a5e0-1f19ae0b0c14", "mailbox_address": "user@example.com", "created_at": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "perPage": 0, "total": 0, "totalPages": 0, "nextCursor": "string" }, "error": null}Remove the alias on the mail server first, then its record; a mail-server refusal is 502 and keeps it. Honours Idempotency-Key. (scope: mailboxes:write) DELETE
Previous Page
The organization's hosted mail domains, read-only; adding and verifying a domain happen in the app (scope: mailboxes:read) GET
Next Page