Specifies the maximum number of rows included in each batch submitted during batch operations.

Data Type

int

Default Value

-1

Remarks

When BatchSize is set to a value greater than 0, the provider splits the entire operation into smaller batches, each containing the number of rows specified by the BatchSize property. These smaller batches are submitted to the server one at a time.

When set to 0, the provider submits the entire batch as a single request. Note that if more than approximately 166 records are submitted, this triggers a REQUEST_MAX_COMPLEXITY_EXCEEDED error. This limit is calculated by Monday based on its complexity limit and is not a strict limit, but 166 records per request is a close approximation.

When set to -1 (default), the provider automatically calculates a safe maximum batch size using 70 percent of the COMPLEXITY_BUDGET_LIMIT, to allow for other operations and to avoid triggering a REQUEST_MAX_COMPLEXITY_EXCEEDED error.

Warning: When a bulk request runs longer than 60 seconds, the API may return a 504 Gateway Timeout error while the server continues processing. The provider interprets this as a failure and retries the request, which can result in duplicate operations, particularly for bulk INSERT. To prevent this, increase the Timeout property or reduce the BatchSize property accordingly so that the request completes within the execution time limit.

BatchSize is useful in situations where the server imposes limits on the size of requests. By splitting the operation into smaller parts, you can work around these limitations and ensure successful batch processing.