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.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a AddFavoriteInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/favorites/user" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "entityType": "",
  "label": "",
  "route": ""
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "entityType": "",
  "label": "",
  "route": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/favorites/user' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, UserFavoritesApi } from '@winkpg/winkpg-api';

const api = new UserFavoritesApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.userFavoritesAdd({
  "entityType": "",
  "label": "",
  "route": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/favorites/user', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "entityType": "",
    "label": "",
    "route": ""
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new UserFavoritesApi(config);
var body = JsonSerializer.Deserialize<AddFavoriteInput>("""
    {
      "entityType": "",
      "label": "",
      "route": ""
    }
    """);

var result = await api.UserFavoritesAddAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/favorites/user");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "entityType": "",
      "label": "",
      "route": ""
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.UserFavoritesApi(client)
    body = winkpg_api.AddFavoriteInput.from_dict({
      "entityType": "",
      "label": "",
      "route": ""
    })
    result = api.user_favorites_add(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "entityType": "",
  "label": "",
  "route": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/favorites/user",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`entityType` required	string	nullablemax length 64pattern ^[a-z0-9_-]+$
`entityId` required	string (uuid)
`scope` required	FavoriteScope	Organizational scope for a pinned favorite. Determines which operating-context fields the favorite is bound to. one of: Tenant, Reseller, Merchant
`label` required	string	nullablemax length 200
`subtitle` required	string	nullablemax length 200
`route` required	string	nullablemax length 512

This request body has no documented fields.