Skip to content
Longport WhaleLongport Whale
Batch Printing

Update Export Batch

Update an existing export batch.

Request parameters

  • Required: batch_id (batch ID), name (batch name), sync_sftp (whether to sync to SFTP), email_notify (whether to send an email notification)
  • Optional: auto_export_timing (auto-export timing; not auto-exported when omitted), visible_emails (emails allowed to see the batch)

Result

On success, the export batch is updated and the result is returned in data. Interpret the outcome together with the business code.

POSThttps://b-api.longbridge.xyz/report/export/update_batch

Authorization

Authorizationstringheaderreport.export_batches_queryRequired

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

Request body application/json

batch_idintegerrequired

Batch ID identifying the export batch to update.

namestringrequired

Batch name.

sync_sftpbooleanrequired

Whether to sync to SFTP.

email_notifybooleanrequired

Whether to send an email notification.

auto_export_timingstring

Auto-export timing; not auto-exported when omitted.

visible_emailsarray<string>

Emails allowed to see the batch. No restriction when omitted.

Responses

HTTP 200The request was processed successfully. The business result is in data.
Standard response envelopecodemessagedata
dataobjectdata structure
rowsstring
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