PATCH
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
portfolios
/
{portfolio_id}
Update a Portfolio
curl --request PATCH \
  --url http://127.0.0.1:3000/v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id} \
  --header 'Content-Type: <content-type>' \
  --data '"{\n  \"name\": \"Portfolio 3 UPDATE\",\n  \"status\": {\n    \"code\": \"BLOCKED\",\n    \"description\": \"Teste Portfolio 3 Update\"\n  },\n  \"metadata\": {\n    \"chave\": \"metadata_chave\",\n    \"bitcoinn\": \"randomBitcoin\",\n    \"boolean\": true,\n    \"double\": 10.5,\n    \"int\": 1\n  }\n}"'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityId": "<string>",
  "name": "<string>",
  "status": {
    "status": {
      "description": "<string>",
      "code": "<string>"
    }
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}
ImportantKeep the following in mind when updating the metadata object:
  • If no metadata is provided, the existing metadata will remain unchanged.
  • Sending an empty metadata object will remove all current metadata.
  • Sending a metadata object with values will overwrite all existing metadata, so be sure to include any pre-existing data you want to retain.

Headers

​
Content-Type
string
required

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

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

​
portfolio_id
string
required

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

Body

application/json
​
name
string
required

The name of the portfolio.

​
entityId
string

The unique identifier of the user responsible for the portfolio.

​
status
object

An object containing information about the status.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field <code>name</code> is the key and the field <code>value</code> 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
object

An object containing information about the status.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field <code>name</code> is the key and the field <code>value</code> 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).