Skip to content
Longport WhaleLongport Whale
Data Service Provider

Create / Edit / Delete Custodian Sub-position

Creates, edits, or deletes a custodian sub-position. All three operations share this single endpoint and are distinguished by action_in.

Request parameters

  • Required: action_in (Action In)
  • Optional: id (ID), custodian_id (Custodian ID), no (Sub Account), name (Sub Account Name), position_direction (Features), remark (Remark), audit_frontend_resource (audit context)
  • See each field for its format, allowed values, and business meaning.

Business notes

  • Create (action_in=1): omit id and submit the sub-position business fields.
  • Edit (action_in=3): send the target record's id together with the fields to update.
  • Delete (action_in=2): call the same endpoint with a body of { id, action_in: "2", audit_frontend_resource }, providing only the target record's id and the audit context.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/clearing/sub_positions

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

action_instringrequired

Specifies Action In. This field is required.

Allowed values:

  • 1 - Add
  • 2 - Delete
  • 3 - Edit

1 · Add2 · Delete3 · Edit

idstring

Sub-position record ID that identifies the target of this request. Required when editing or deleting.

custodian_idstring

Specifies Custodian ID, identifying the custodian that owns the sub-position.

falsestring

Specifies Sub Account.

namestring

Specifies Sub Account Name.

position_directionstring

Specifies the sub-position Features (position direction).

remarkstring

Specifies Remark.

audit_frontend_resourcestring

Caller-provided audit context used for operation audit logging. The delete operation submits this field together with the request body.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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