---
title: "Set a resource as favorite."
method: POST
path: "/favorites/resource/{foreignId}.json"
tags: ["Favorites"]
---

# Set a resource as favorite.

`POST /favorites/resource/{foreignId}.json`

## Request

- Base URL: `https://passbolt.local`
- URL: `https://passbolt.local/favorites/resource/{foreignId}.json`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/passbolt/apis/passbolt-api/docs/favorites/resource/:foreignId.json/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `foreignId` string, uuid, required

## Response `200`

Operation is successful

- object
  - `header` Header, required
    - `id` string, uuid, required
    - `status` 'success' | 'error', required
    - `servertime` integer, required
    - `action` string, uuid, required
    - `message` string, required
    - `url` string, uri, required
    - `code` integer, required
  - `body` Favorite, required
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `foreign_key` string, uuid, required
    - `foreign_model` 'Resource', required
    - `created` string, date-time, required
    - `modified` string, date-time, required

## Other responses

- `400`: Bad request
- `401`: Authentication required.
- `404`: Not found

## Changes

- **2026-11-06** `8d72215e2274`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/passbolt/apis/passbolt-api/changes/favorites/resource/:foreignId.json/post.md)

---

[API](https://skmtc.dev/passbolt/apis/passbolt-api.md) - [All operations](https://skmtc.dev/passbolt/apis/passbolt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passbolt/apis/passbolt-api/revisions/8d72215e2274?raw)