Create Monitoring Portfolio

This endpoint to create a new Portfolio based on the supplied criteria.

A portfolio can contain any number of companies that you wish to monitor changes to. The only required Body parameter is "name" for Connect users.

SecuritybearerToken
Request
Request Body schema: application/json
required
name
required
string

The name of the portfolio

isDefault
boolean

can set the portfolio as default for company monitoring events.

Array of objects

The email address of the user to receive the email notification.

emailSubject
string

The subject of the email notification.

emailLanguage
string

The language of the email notification.

frequency
string
Responses
200
400
401
post/monitoring/portfolios
Request samples
application/json
{
  • "name": "Test Portfolio",
  • "isDefault": false,
  • "emails": [
    ],
  • "emailSubject": "Creditsafe Monitoring Notification on portfolio {{portfolioName}}",
  • "emailLanguage": "en",
  • "frequency": "string"
}
Response samples
application/json
{
  • "correlationId": "14cc64a0-c108-11ea-b9af-06bcc69a383e",
  • "portfolioId": 131318,
  • "name": "My New Portfolio",
  • "isDefault": false
}
➔ Next to GM Importing Portfolios / Import A Portfolio File