latestOpenAPI 3.0.12026-07-24241275527.9 KB
f1c1279c29d6
Batch operations
Create Batch Operation
<h3>Overview</h3><p>The Batch API lets you execute multiple operations asynchronously in a single request to reduce API calls and rate-limit pressure.</p><ul><li>Supports <b>up to 100 operations per batch</b></li><li>Operations are executed <b>asynchronously</b> and <b>independently</b> (not transactional)</li><li>A batch may contain <b>heterogeneous operation types</b></li></ul><h3>Execution & Results</h3><p><code>POST /batch</code> schedules an asynchronous job and returns an <code>asyncJobId</code></p><ul><li>Use the <a href="api/v4/async-job/#get-async-job">Async Job API</a> to track progress and retrieve per-operation results</li><li>Partial success is possible; each operation returns its own status</li></ul><h3>Quota</h3><ul><li>Batch operations consume a per-account operation quota that replenishes as operations complete</li><li>Requests may be rejected if insufficient quota is available</li></ul>.<b>Scopes:</b> Default, wsReadWrite
post/batch
Query parameters
Array of operations to execute. Limit : 100
Response
success response