DRdrivewealth
User Notes

Edit User Note

Updates an existing note on a user. Behaves identically to PUT on this same path - both are fully supported.

patch/users/{userID}/notes/{userNoteID}

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/users/{userID}/notes/{userNoteID}
  • Auth
    HTTP bearer

Path parameters

userIDstring required

sensitive The User's unique identifier.

userNoteIDstring required

The unique identifier of the note being edited.

Request body

subjectstring required

A short title for the note.

notestring

sensitive The note body. Required when creating a note; optional when editing one.

category'USERS' | 'ACCOUNTS' | 'ORDERS' | 'ACATS' | 'KYC' | 'CORPORATE_ACTIONS' | 'INSTRUMENTS' | 'PAYMENTS' | 'TRANSACTIONS' | 'TAX' | 'STATEMENTS' | 'SUBSCRIPTIONS' | 'PORTFOLIO' | 'GFV' | 'FPSL' | 'POSITIONS' | 'PDT' | 'TEFRA' | 'OTHER'

The area of the business a note relates to.

visibility'INTERNAL' | 'EXTERNAL'

INTERNAL notes are visible only within DriveWealth; EXTERNAL notes are also visible to the partner.

Example request

{
  "subject": "Called client re: KYC docs",
  "note": "Client confirmed documents will be uploaded by Friday."
}

Response

The note was updated successfully.

idstring required

The note's unique identifier.

createdstring date-time

When the note was created.

subjectstring
notestring

sensitive

createdBystring

sensitive The username of whoever created the note.

category'USERS' | 'ACCOUNTS' | 'ORDERS' | 'ACATS' | 'KYC' | 'CORPORATE_ACTIONS' | 'INSTRUMENTS' | 'PAYMENTS' | 'TRANSACTIONS' | 'TAX' | 'STATEMENTS' | 'SUBSCRIPTIONS' | 'PORTFOLIO' | 'GFV' | 'FPSL' | 'POSITIONS' | 'PDT' | 'TEFRA' | 'OTHER'

The area of the business a note relates to.

visibility'INTERNAL' | 'EXTERNAL'

INTERNAL notes are visible only within DriveWealth; EXTERNAL notes are also visible to the partner.

Example response

{
  "id": "123e4567-e89b-12d3-a456-000000000165",
  "created": "2026-06-15T14:22:01.000Z",
  "subject": "Called client re: KYC docs",
  "note": "Client confirmed documents will be uploaded by Friday.",
  "createdBy": "jsmith",
  "partner": {
    "id": "123e4567-e89b-12d3-a456-000000000005",
    "name": "Acme Brokerage"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.