Skip to content
Longport WhaleLongport Whale
Corp Action Management

Corporate Action - Notify Clients Email Preview

Renders and returns a preview of the email that would be sent, before triggering the actual batch notification.

Request parameters

  • Required: ann_id (corporate action ID), type (notify type)
  • Optional: excluded_aaids (list of account AAIDs to exclude)
  • The request parameters are identical to Notify Clients (/corporate_action/notify).

Response

On success, the email preview is returned in data.payload. payload is a JSON string; after parsing, its data.body holds the email body HTML.

POSThttps://b-api.longbridge.xyz/corporate_action/notify/render

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

ann_idintegerrequired

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

typestringrequired

Notify type.

Allowed values:

  • 0 - Unspecified
  • 1 - Delayed delivery
  • 2 - Adjustment

0 · Unspecified1 · Delayed delivery2 · Adjustment

excluded_aaidsarray<string>

List of account AAIDs to exclude; excluded accounts are not included in this preview. When omitted, no account is excluded. Candidate accounts can be obtained via corporate_register_aaids.

Responses

HTTP 200The request was processed successfully. The email preview is returned in data.payload.
Standard response envelopecodemessagedata
dataobjectdata structure
payloadstringrequired

Email preview content as a JSON string. The caller must parse it as JSON; the parsed data.body holds the email body HTML.

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