---
title: "Request mailbox rename"
method: POST
path: "/api/v1/mailboxes/rename-request"
tags: ["Mailboxes"]
---

# Request mailbox rename

`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`

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

## Request body

- MailboxRenameRequest: Rename request for one or more mailboxes. Does not rename them.
  - `mailboxes` MailboxRenameItem[], required: Mailboxes to rename
    - `id` integer: Mailbox ID. Used when email is omitted.
    - `email` string: Current email address
    - `new_email` string: Email address the mailbox should be renamed to
    - `new_first_name` string: New first name
    - `new_last_name` string: New last name

## Response `200`

Rename request submitted, or pending mailboxes were skipped

- MailboxRenameRequestApiResponse
  - `success` boolean: Success flag
  - `data` MailboxRenameRequestResponse: Result of submitting a mailbox rename request. Mailboxes are not renamed.
    - `requested_count` integer: Number of mailboxes included in the request
    - `requested_mailboxes` MailboxRenameRequestedMailbox[]: Mailboxes included in the request
      - `id` integer
      - `email` string
      - `status` string
      - `new_email` string
      - `first_name` string
      - `last_name` string
      - `new_first_name` string
      - `new_last_name` string
    - `skipped` MailboxRenameRequestSkipped[]: Mailboxes that were not sent to the team
      - `id` integer
      - `email` string
      - `reason` string
    - `not_found` string[]: IDs or emails that were not found on this account
    - `message` string: Confirmation of what was submitted
  - `timestamp` string: Response timestamp

## Other responses

- `400`: No matching mailboxes, or the mailbox list is empty
- `401`: Unauthorized - Invalid or expired API key
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/aerosend/apis/aerosend-developer-api.md) · [All operations](https://skmtc.dev/aerosend/apis/aerosend-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aerosend/apis/aerosend-developer-api/revisions/9828eeb89b1f?raw)