Favorites

Delete a favorite email folder

The folder's board is archived, not destroyed: restore it with POST /v1/boards/{boardId}/restore. With move_items_to_root, items go to the scope's "Unsorted" board. Deprecated: favorites are now V3 boards; use /v1/boards. This endpoint is a compatibility facade over boards: folder ids are board ids (migrated V2 folder UUIDs are still accepted), saved favorite ids are board item ids, and favorites without a folder live in the scope's "Unsorted" board.

delete/v1/favorites/emails/folders/{folderId}

Request

Base URL: https://api.trendtrack.io (the document declares no server; this is the origin it was published from)
URL: https://api.trendtrack.io/v1/favorites/emails/folders/{folderId}
Auth: HTTP bearer

Path parameters

folderIdstring required

Folder id: a board id, or the UUID of a V2 folder migrated to a board.

Example:board_8b7c6d5e-4f3a-4b2c-9d1e-0f1a2b3c4d5e

Query parameters

scope'workspace' | 'personal' required

Favorites scope. Use personal only with a delegated_user credential. full_access credentials receive 403 for personal scope.

Request body

mode'delete_items' | 'move_items_to_root' | 'move_items_to_folder' required

targetFolderIdobject nullable

Response

Favorite email folder delete response.

requestIdstring required

Example response

{
  "requestId": "5d93d8de-0f6d-46a4-bd10-2e519b7e96bc",
  "data": {
    "deleted": true,
    "folderId": "0e91fbef-3d02-44d8-b024-3bda62fb050c",
    "scope": "workspace"
  }
}

Changes

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