Skip to content
Print Report

Create or Update Bookmark Directory

Create or update a report bookmark directory.

A single endpoint handles both create and update: pass dir_id to update that directory, or omit it to create a new one.

Request parameters

  • Required: name (directory name)
  • Optional: dir_id (bookmark directory ID; provide to update, omit to create)
  • See each field for its format, allowed values, and business meaning.

Result

On success, data.dir_id returns the ID of the created or updated directory.

POSThttps://b-api.lbkrs.com/report/bookmark/add_dir

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_report.report_printing

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Request body application/json

namestringrequired

This field is required.

dir_idstring

Bookmark directory ID. Provide the target directory's ID when updating; omit when creating.

Responses

HTTP 200The request was processed successfully. data contains dir_id.
Standard response envelopecodemessagedata
dataobjectdata structure
dir_idstring

ID of the created or updated folder.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs