Create a new FavoriteList

POST 
/v1/favoritelists

Create a new FavoriteList

Request

application/json

Body

required

Create FavoriteList input

productIds integer[]

Favorite List product IDs list

productSources string[]

List of product sources

clusterIds integer[]

Favorite List cluster IDs list

clusterSources string[]

List of cluster sources

isDefault booleanrequired

Favorite List is default

name stringrequired

Possible values: <= 64 characters

Favorite List name

companyId int

Favorite List company ID

companySource

object

id stringrequired

Source ID

name stringrequired

Name of the source

contactId int

Favorite List contact ID

contactSource

object

id stringrequired

Source ID

name stringrequired

Name of the source

customerId int

Favorite List customer ID

customerSource

object

id stringrequired

Source ID

name stringrequired

Name of the source

Responses

201

FavoriteList created

application/json

Schema

Schema

name stringrequired

Possible values: <= 64 characters

Favorite List name

companyId int

Favorite List company ID

contactId int

Favorite List contact ID

customerId int

Favorite List customer ID

productIds number[]

Favorite List product IDs list

clusterIds number[]

Favorite List cluster IDs list

isDefault booleanrequired

Default Favorite List

slug stringrequired

Favorite List slug

createdAt date-time

Favorite List date created

updatedAt date-time

Favorite List date modified

id stringrequired

Favorite List identifier

Example (from schema)

{
  "name": "MyFavoriteList",
  "companyId": 1111,
  "contactId": 1111,
  "customerId": 1111,
  "productIds": [
    1111,
    2222,
    3333
  ],
  "clusterIds": [
    1111,
    2222,
    3333
  ],
  "isDefault": true,
  "slug": "my-favorite-list-slug",
  "createdAt": "2022-01-01T00:00:00.000Z",
  "updatedAt": "2022-01-01T00:00:00.000Z",
  "id": "64e896addf2137b255101f49"
}

400

Bad request

403

Forbidden

500

Unknown create FavoriteList error

Loading...