Sync A Portfolio File

Request

Endpoint allows you to sync a portfolio file with your portfolio.

Sync action will delete all companies in your specified portfolio, and then add the companies from the file into the portfolio.

IMPORTANT: Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: Import and Sync Companies documentation

Security

bearerToken

Path

portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

Bodymultipart/form-datarequired

importcsvstring, (binary)

The import file ideally needs to be a .csv file.

emailstring

Option field. Provide an email and get a notification when the import has been completed with the details about the import.

Example:"john.smith@creditsafe.com"

curl -i -X POST \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F importCsv=FILE_PATH \
  -F email=john.smith@creditsafe.com

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

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

statusstring

A message about the status of this request.

Example:"Accepted for processing. Import Id 339523"

Response

{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "status": "Accepted for processing. Import Id 339523"
}