Skip to content

Reference

ledger.updatePartyDetails

PATCH /v2/parties/{party} — merge-update party metadata using protobuf-style masks.

Patches PATCH /v2/parties/{party} using UpdatePartyDetailsParams separating party path portion versus partyDetails payload (party, isLocal, optional localMetadata, identityProviderId) plus updateMask.paths controlling partial updates identical REST users semantics.

Receiver: await canton.ledger.updatePartyDetails

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Minimal example

await canton.ledger.updatePartyDetails({
  party: canton.getPartyId(),
  partyDetails: {
    party: canton.getPartyId(),
    isLocal: true,
  },
  updateMask: { paths: ['isLocal'] },
});

Parameters — UpdatePartyDetailsParams

Validated UpdatePartyDetailsParamsSchema (schemas/operations/parties.ts).

Returns — UpdatePartyDetailsResponse

Acknowledgement payload referencing mutated PartyDetails.

Errors and pitfalls

Concurrent edits rely Canton etag semantics—watch 409 conflicts bridging metadata.resourceVersion interplay identical docs referencing concurrency guards.

Auth and party

OAuth bearer identity needing ParticipantAdmin / delegated party maintenance ACL.

See also

Source

operations/v2/parties/update-party-details.ts