Skip to content
Longport WhaleLongport Whale
Corp Action Management

Corporate Action - Notify Clients (Batch)

Sends email notifications in bulk to the registered clients of a corporate action.

Request parameters

  • Required: ann_id (corporate-action ID), type (notification type).
  • Optional: excluded_aaids (accounts to exclude; listed accounts will not receive this notification).
  • ann_id can be obtained via corporate_register_aaids.

Risk warning

This operation sends emails to real clients. Confirm the corporate action, notification type, and exclusion list before calling; previewing the email content first is recommended.

Result

On success the bulk email notification is triggered; the outcome is in data. Interpret it together with the business code.

POSThttps://b-api.lbkrs.com/corporate_action/notify

Authorization

AuthorizationstringheaderRequired

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

Permission

corporate.email_notify

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

Request body application/json

ann_idintegerrequired

Corporate action ID identifying the corporate action to notify. Obtain it via corporate_register_aaids by passing a ca_code.

typestringrequired

Notify type.

Allowed values: 1 Delayed dividend payment notice, 2 Dividend amount of the corporate action may be adjusted

Values
0
Unspecified
1
Delayed delivery
2
Adjustment
excluded_aaidsarray<string>

List of account AAIDs to exclude; excluded accounts will not receive this notification. When omitted, no account is excluded. Candidate accounts can be obtained via corporate_register_aaids.

Responses

HTTP 200The request was processed successfully. The result is returned in data.
Standard response envelopecodemessagedata
dataobjectdata structure

Result of the batch notification.

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