Add Company To Portfolio

Endpoint to add a company using a company id, into a portfolio provided in as a path parameter. Additional fields can be used to add a personalReference, freeText, and personalLimit. These fields need to be submitted in the requestBody but can be 'nulled' if not required. See the two examples of the submission with and without these fields.

SecuritybearerToken
Request
path Parameters
portfolioId
required
number

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

Request Body schema: application/json
optional
id
required
string

The company Safe Number or Connect ID

personalReference
required
string or null

A personal reference for the company

freeText
required
string or null

A free field to add any additional text to the company in the portfolio

personalLimit
required
string or null

A personal limit for the company - separate from the credit limit

Responses
200
400
401
404
409
post/monitoring/portfolios/{portfolioId}/companies
Request samples
application/json
{
  • "id": "GB-0-12345678",
  • "personalReference": "",
  • "freeText": "",
  • "personalLimit": ""
}
Response samples
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "message": "Company Added"
}