Clear items from FavoriteList

PATCH 
https://api.helice.cloud/v1/favoritelists/:id/clear-items

Clear items from FavoriteList

Request

Path Parameters

id stringrequired
FavoriteList identifier
Example: 60f1b9b3b3b3b3b3b3b3b3b3

Query Parameters

products boolean
Clear products
Example: false
clusters boolean
Clear clusters
Example: false

Responses

200

Items cleared from FavoriteList

application/json

Schema

Schema

namestringrequired
Favorite List name
Possible values: <= 64 characters
Example: MyFavoriteList
companyIdint
Favorite List company ID
Example: 1111
contactIdint
Favorite List contact ID
Example: 1111
customerIdint
Favorite List customer ID
Example: 1111
productIdsnumber[]
Favorite List product IDs list
Example: [1111,2222,3333]
clusterIdsnumber[]
Favorite List cluster IDs list
Example: [1111,2222,3333]
isDefaultbooleanrequired
Default Favorite List
Example: true
slugstringrequired
Favorite List slug
Example: my-favorite-list-slug
createdAtdate-time
Favorite List date created
Example: 2022-01-01T00:00:00.000Z
updatedAtdate-time
Favorite List date modified
Example: 2022-01-01T00:00:00.000Z
idstringrequired
Favorite List identifier
Example: 64e896addf2137b255101f49

Example (auto)

{
  "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

404

FavoriteList not found

500

Unknown clear items from FavoriteList error

Authorization: OAuth2

name: OAuth2type: oauth2bearerFormat: tokenscheme: bearerdescription: OAuth2 Authorizationin: headerflows: {
  "clientCredentials": {
    "tokenUrl": "https://api.helice.cloud/oauth2/token/",
    "scopes": {}
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.helice.cloud/v1/favoritelists/:id/clear-items");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <OAuth2>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.helice.cloud

Auth

Bearer Token

Parameters

id — pathrequired

products — query

---truefalse

clusters — query

---truefalse

ResponseClear

Click the Send API Request button above and see the response here!