Favorites

Remove a favorite email by email id

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/{emailId}

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/{emailId}
  • Auth: HTTP bearer

Path parameters

emailIdinteger required

Public email identifier. To delete a saved favorite row by favorite_emails.uuid, use DELETE /v1/favorites/emails/saved/:favoriteId.

Query parameters

scope'workspace' | 'personal' required

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

folderIdstring

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

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

Favorite emails folder id (board id, or migrated V2 folder UUID). Omit to remove from the scope's "Unsorted" board.

Response

Favorite email removal response.

requestIdstring required

Example response

{
  "requestId": "5d93d8de-0f6d-46a4-bd10-2e519b7e96bc",
  "data": {
    "removed": true,
    "emailId": 7298813,
    "scope": "workspace",
    "folderId": "0e91fbef-3d02-44d8-b024-3bda62fb050c",
    "savedFavoriteId": "f3d7c2da-e64c-42c3-a0b1-ef1a4633592d"
  }
}

Changes

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