Skip to content
Longport WhaleLongport Whale
Auto Forceselling Switch

Update Covered Option Close-Out Rule

Updates the covered-options auto-liquidation subrule. This operation changes the live auto-liquidation configuration and is extremely high risk.

Request parameters

  • Required: is_enable_covered_opt_close_out (Enable Covered Option Close-Out), is_skip_short_option (Skip Short Option)
  • Optional: covered_opt_close_out_trigger_time (Trigger Close-Out Time), audit_frontend_resource (Audit Context)
  • See each field for its format, allowed values, default behavior, and business meaning.

Risk notice

This operation may affect live business data or asset state. Verify the target records, amounts, quantities, and operation type before calling it.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

POSThttps://b-api.longbridge.xyz/v1/risk_monitoring/covered_opt_close_out/rules/update

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

is_enable_covered_opt_close_outbooleanrequired

Boolean flag for enable covered option close-out. this field is required.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply
covered_opt_close_out_trigger_timestring

In HH:mm format; required when the rule is enabled.

is_skip_short_optionbooleanrequired

Boolean flag for skip short option. this field is required.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply
audit_frontend_resourceobject

Records a snapshot of the rule before modification (whether option covered close-out is enabled, the trigger time, and whether selling options is skipped) before submission, for before-and-after comparison in the approval ticket.

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