v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Update Ledger

patch/ledgers/{id}

Path parameters

idstring required

The ID of the ledger.

Request body

namestring

The name of the ledger. Maximum of 1000 characters allowed.

descriptionstring

An optional free-form description for internal use. Maximum of 1000 characters allowed.

metadatastring json

Response

200

idstring

objectstring

live_modeboolean

namestring

{"stackTrail":"paths:/ledgers/{id}:patch:responses:200:content:application/json:schema:properties:description","oasType":"schema","type":"unknown"}

metadataobject

{"stackTrail":"paths:/ledgers/{id}:patch:responses:200:content:application/json:schema:properties:discarded_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "641e15b7-a326-44b1-9ed2-536cd327101b",
  "object": "ledger",
  "name": "Customer Ledger",
  "created_at": "2022-11-01T20:50:56Z",
  "updated_at": "2022-11-01T20:54:22Z"
}