Mailboxes

Request mailbox rename

Submits a rename request for one or more mailboxes for the authenticated client. Mailboxes are not renamed.

Rename Rules

  • Changes the email address and/or first and last name
  • Mailboxes that are not pending (typically active) are included in the request
  • The Aerosend team handles the change
  • Mailboxes with pending status are skipped. Delete the pending mailbox and add a new one instead
  • Does not change the mailbox

Identifiers

  • Each item needs id or the current email
  • Each item also needs new_email and/or new_first_name / new_last_name

Response

  • Returns the current address and the requested email or name
  • Returns skipped mailboxes with reasons
  • Returns identifiers that were not found on the account
post/api/v1/mailboxes/rename-request

Request

  • Base URL: https://api.aerosend.io
  • URL: https://api.aerosend.io/api/v1/mailboxes/rename-request
  • Auth: API key in header X-API-Key

Request body

Example request

{
  "mailboxes": [
    {
      "id": 456,
      "email": "john@example.com",
      "new_email": "jane@example.com",
      "new_first_name": "Jane",
      "new_last_name": "Doe"
    }
  ]
}

Response

Rename request submitted, or pending mailboxes were skipped

successboolean

Success flag

timestampstring

Response timestamp

Example response

{
  "success": true,
  "data": {
    "requested_count": 1
  },
  "timestamp": "2025-12-14T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.