Clear Companies From Portfolio

This endpoint allows for companies to be deleted from the specified portfolio.

SecuritybearerToken
Request
path Parameters
portfolioId
required
number

The unique identifier of the portfolio you want to delete companies from, obtained from /portfolios.

query Parameters
clearAll
boolean
Default: false

When ClearAll query parameter is False,Companies List needs to be passed. When ClearAll query parameter is True, Companies List must be empty. All companies will be deleted

Request Body schema: application/json
required
companies
Array of strings
Responses
200
400
401
404
patch/monitoring/portfolios/{portfolioId}/companies/clear
Request samples
application/json
{
  • "companies": [
    ]
}
Response samples
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "message": "Companies deleted from portfolio"
}
➔ Next to Get Company Details From A Portfolio