Create Monitoring Portfolio

Request

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.

Security

bearerToken

Bodyapplication/jsonrequired

namestringrequired

The name of the portfolio

Example:"Test Portfolio"

isDefaultboolean

can set the portfolio as default for company monitoring events.

Example:false

emailsArray of objects

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

emailSubjectstring

The subject of the email notification.

Example:"Creditsafe Monitoring Notification on portfolio {{portfolioName}}"

emailLanguagestring

The language of the email notification.

Example:"en"

frequencystring

The frequency property must be set to "1" to activate email notifications.

Example:"1"

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Test Portfolio",
    "isDefault": false,
    "emails": [
      {
        "firstName": "John",
        "lastName": "Doe",
        "emailAddress": "john.doe@creditsafe.com"
      }
    ],
    "emailSubject": "Creditsafe Monitoring Notification on portfolio {{portfolioName}}",
    "emailLanguage": "en",
    "frequency": "1"
  }'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

Example:"14cc64a0-c108-11ea-b9af-06bcc69a383e"

portfolioIdnumber

A unique ID assigned to each portfolio.

Example:131318

namestring

The name that was assigned to this portfolio

Example:"My New Portfolio"

isDefaultboolean

Shows if the portfolio is set as Default for the user.

Example:false

Response

{
  "correlationId": "14cc64a0-c108-11ea-b9af-06bcc69a383e",
  "portfolioId": 131318,
  "name": "My New Portfolio",
  "isDefault": false
}