Mail

Rename a folder

Gives the folder a new name in place: a nested folder stays under its parent and its messages stay where they are. The system folders (Inbox, Sent, Drafts, Trash, Junk, Archive) cannot be renamed (403). Requires scope mail:write.

put/mailboxes/{address}/folders/{path}

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes/{address}/folders/{path}
  • Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

pathstring required

The folder's path from the list endpoint. A nested folder keeps its slashes: Projects/2026.

Request body

namestring required

The new name (one segment); the folder stays under its parent

Example request

{
  "name": "2027"
}

Response

Folder renamed

successboolean

Example response

{
  "success": true,
  "data": {
    "path": "Projects/2026"
  }
}

Changes

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