Favorites

Move a saved favorite email

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.

patch/v1/favorites/emails/saved/{favoriteId}/folder

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

Path parameters

favoriteIdstring required
Example:board_item_3f1c2b7e-8d4a-4f0e-9b1a-2c3d4e5f6a7b

Saved favorite id, which is the board item id.

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

folderIdobject nullable

Favorite emails folder id (board id, or migrated V2 folder UUID). Null moves the saved email to the scope's "Unsorted" board.

Response

Saved favorite email move response.

requestIdstring required

Example response

{
  "requestId": "5d93d8de-0f6d-46a4-bd10-2e519b7e96bc",
  "data": {
    "id": "board_item_f3d7c2da-e64c-42c3-a0b1-ef1a4633592d",
    "scope": "workspace",
    "savedAt": "2026-04-20T10:00:00.000Z",
    "folder": {
      "id": "board_0e91fbef-3d02-44d8-b024-3bda62fb050c",
      "name": "Lifecycle Emails",
      "parentId": "board_4b84a8f9-44df-4a18-9f08-66e6db6403da"
    },
    "email": {
      "id": 123456,
      "sentAt": "2026-04-18T12:30:00.000Z",
      "campaignType": "Newsletter",
      "classification": {
        "promotionType": "Discount %",
        "promotionTypeId": 1,
        "category": "Promotional Campaign",
        "categoryId": 4,
        "event": {
          "name": "Black Friday",
          "id": 1,
          "category": "Commercial Events"
        }
      },
      "content": {
        "subject": "Up to 30% off this weekend",
        "preheader": "Limited-time offers picked for you.",
        "bodyPreview": "Shop limited-time offers picked for you before they are gone.",
        "bodyLength": 428,
        "screenshotUrl": "https://cdn.example.com/emails/123.png"
      },
      "shop": {
        "id": "3f8aa146-6f96-46e8-9781-64db5166f9a8",
        "domain": "example.com",
        "name": "Example Shop"
      }
    }
  }
}

Changes

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