Skip to main content
PATCH
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
portfolios
/
{portfolio_id}
Update a Portfolio
curl --request PATCH \
  --url https://onboarding.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id} \
  --header 'Content-Type: <content-type>' \
  --data '{
  "name": "High-Value Customer Portfolio - Updated",
  "status": {
    "code": "BLOCKED",
    "description": "Portfolio temporarily blocked due to compliance review"
  },
  "metadata": {
    "riskProfile": "medium",
    "portfolioManager": "wealth-management-team",
    "minBalanceRequirement": 600000,
    "automaticEnrollment": true,
    "eligibilityCriteria": "KYC level 4 and internal credit score > 820",
    "currencyExposure": [
      "USD",
      "BRL",
      "EUR",
      "GBP"
    ],
    "investmentProfile": "balanced"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityId": "<string>",
  "name": "<string>",
  "status": "<any>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Headers

​
Authorization
string

The authorization token. This header is required if your environment has the Access Manager enabled.

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string<uuid>
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string<uuid>
required

The unique identifier of the associated Ledger.

​
portfolio_id
string<uuid>
required

The unique identifier of the portfolio that you want to retrieve, delete or update.

Body

application/json
​
entityId
string

The unique identifier of the user responsible for the portfolio.

​
name
string

The name of the portfolio.

​
status
object

An object containing information about the status. Important: If not provided, the default status will be 'ACTIVE'.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Response

Indicates that the request was successful and the response contains the expected data.

​
id
string<uuid>

The unique identifier of the portfolio.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
entityId
string

The unique identifier of the user responsible for the portfolio.

​
name
string

The name of the Portfolio.

Maximum length: 256
​
status
any
​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).