Pin an entity as a favorite for the operating user.
POST
/api/favorites/user
deprecated
Requires: Favorites.Manage, merchant scope.
Idempotent for a given `(operating user, entityType, entityId)`: pinning something already pinned, or re-pinning an entity the user previously removed, returns the existing (or restored and refreshed) favorite instead of creating a duplicate. `entityType` must be a lowercase slug and `route` must be a local app-relative path (absolute URLs and path traversal are rejected). Each user has a maximum number of favorites; exceeding the cap is rejected rather than silently evicting the oldest.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.