Add favorite

Request

Add a favorite item for a user.

Security

Bearer

Path

userIdstring, (uuid)required

Identifier for user.

Example:4974a66b-7493-4f41-908c-58ba81093947

Bodyapplication/jsonrequired

typestringrequired

The type of favorite (e.g. "company", "legal_entity", "trip").

paramsobject

Key-value pairs of parameters for the favorite.

displayNamestringrequired

Display name for the favorite item.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/favorites \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "string",
    "params": {
      "property1": "string",
      "property2": "string"
    },
    "displayName": "string"
  }'

Responses

OK

Bodyapplication/json

favoriteobject(FavoriteItem)

A single favorite item.

Response

{
  "favorite": {
    "favoriteId": "string",
    "type": "string",
    "params": { … },
    "displayName": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}