Create a batch operation

Creates an asynchronous batch operation. All items in the batch are processed with the same operation type, which also determines the structure of each item's payload.

The operation is accepted with a Location header pointing to it and processed asynchronously. Poll the retrieve operation to track its progress.

In addition to operations.manage, the credential must have the permission required by the selected operation type. Repeating the request with the same Idempotency-Key returns the same operation instead of creating a new one.

The request is rejected with operation_type_unknown for an unsupported type, duplicate_item_key when item keys are not unique, too_many_items when the batch exceeds the maximum number of items for the type, and operation_backlog_exceeded when the account has too many unfinished operations.

Header Parameters

Response Body

curl -X POST "https://example.com/operations/batches" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "key": "string",        "payload": {}      }    ],    "type": "string"  }'

{  "data": {    "attempt": {      "number": 0,      "status": "running"    },    "cancellation_requested": true,    "created_at": "2019-08-24T14:15:22Z",    "error": {      "code": "worker_error",      "field": "string",      "message": "string",      "reason": "string",      "resource_id": "string"    },    "expires_at": "2019-08-24T14:15:22Z",    "finished_at": "2019-08-24T14:15:22Z",    "id": "string",    "items_url": "string",    "object": "operation",    "progress": {      "done": 0,      "failed": 0,      "total": 0    },    "result_url": "string",    "started_at": "2019-08-24T14:15:22Z",    "status": "queued",    "type": "string"  }}