Clear Companies From Portfolio

Request

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

Security

bearerToken

Path

portfolioIdnumberrequired

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

Query

clearAllboolean

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

Default:false

Bodyapplication/jsonrequired

companiesArray of strings

curl -i -X PATCH \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/clear?clearAll=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companies": [
      "BE-X-733313367",
      "BE-X-868222848"
    ]
  }'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

Example:"23921650-c073-11ea-860f-06bc8182190e"

messagestring

A message stating if your request was successful.

Example:"Companies deleted from portfolio"

Response

{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "message": "Companies deleted from portfolio"
}