Ledgers

Update ledger name

Update the name of an existing ledger with the Go SDK.

PUT/ledgers/{ledger_id}

Use client.Ledger.Update to edit the name of a specific ledger.

Call the method

ledger, _, _ := client.Ledger.Update(
	"ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
	blnkgo.UpdateLedgerRequest{
		Name: "Updated Customer Savings Ledger",
	},
)
FieldTypeDescription
idstringLedger ID to update.
NamestringNew display name for the ledger.

Response

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "Updated Customer Savings Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "project_owner": "Acme LLC",
    "description": "For all savings account created & managed by Acme."
  }
}

Go response (*blnkgo.Ledger)

FieldTypeDescription
LedgerIDstringUnique ID for the ledger. Unchanged after the update.
NamestringUpdated name you passed in the request.
CreatedAttime.TimeDate and time the ledger was created.
MetaDataMetaDataExisting metadata on the ledger. Not modified by this method.