Edit User Note

patch

https://bo-api.drivewealth.io/back-office/users/{userID}/notes/{userNoteID}

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

Path Params

userID

string

required

The User's unique identifier.

userNoteID

string

required

The unique identifier of the note being edited.

Body Params

subject

string

required

A short title for the note.

note

string

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

category

string

enum

The area of the business a note relates to.

Show Details

USERS	Relates to the user's profile or identity.
ACCOUNTS	Relates to one of the user's accounts.
ORDERS	Relates to order entry or execution.
ACATS	Relates to an ACATS (Automated Customer Account Transfer Service) transfer.
KYC	Relates to Know Your Customer identity verification.
CORPORATE_ACTIONS	Relates to a corporate action (e.g. a stock split or merger).
INSTRUMENTS	Relates to a tradable instrument.
PAYMENTS	Relates to a deposit, withdrawal, or other payment.
TRANSACTIONS	Relates to a ledger transaction.
TAX	Relates to tax reporting or withholding.
STATEMENTS	Relates to an account statement.
SUBSCRIPTIONS	Relates to a recurring subscription.
PORTFOLIO	Relates to portfolio or managed-allocation activity.
GFV	Relates to a Good Faith Violation.
FPSL	Relates to Fully Paid Securities Lending.
POSITIONS	Relates to a held position.
PDT	Relates to Pattern Day Trading status or restrictions.
TEFRA	Relates to TEFRA (Tax Equity and Fiscal Responsibility Act) withholding.
OTHER	Doesn't fit any other category.

visibility

string

enum

On create (POST): a value of INTERNAL from any caller outside DriveWealth is silently treated as EXTERNAL - no error is raised, unlike the GET list filter's 403 for the same case. On edit (PUT/PATCH): this field is not honored at all - a note's visibility is fixed at creation and cannot be changed by editing it, for any caller.

Show Details

INTERNAL	Visible only to DriveWealth-internal callers.
EXTERNAL	Visible to DriveWealth-internal callers and the partner.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200The note was updated successfully.

400Bad Request