Skip to content
Longport WhaleLongport Whale
Corp Action Management

Sync Announcement

Creates a corporate action by syncing from an advance-notice code (corporate-action code). This is an alternative to manual creation.

Request parameters

  • Required: ca_code (corporate-action code).
  • See the field descriptions for the format, allowed values, and business meaning of each field.

Business notes

Syncs the corporate-action announcement from upstream by advance-notice code, for use in the later registration, notification, and execution flows.

Risk warning

This operation adds corporate-action business data. Confirm the corporate-action code before calling.

Result

On success the corporate action is created; see the 200 response for the resulting state and data.

POSThttps://b-api.lbkrs.com/v1/sync/announcement

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

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

Request body application/json

ca_codestringrequired

This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring
ann_typeinteger
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