Create Batch
POST /v2/batch/operations
Required scopes
batch:operations:write
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | createBatch |
| Tags | Batch |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Idempotency-Key | header | string | Per `00-conventions.md` §7. Client-generated UUID v4 recommended. |
| X-Operator-Override | header | string | Comma-separated override flags. Standard set: destructive, bulk, force, bypass_validation=<validator>, dry_run. |
Request body
Required
object
| Field | Type | Description |
|---|---|---|
| operation * | schema | |
| source * | oneOf<object | object | object | object> | |
| params | object | Per-operation Params shape; see 04-batch.md §3.x for the typed shape per BatchOperationKind. |
Responses
201
Created
object
| Field | Type | Description |
|---|---|---|
| id * | schema | |
| surface * | enum (3) | partneripaasbatch |
| operation * | schema | |
| status * | enum (6) | acceptedrunningsucceededpartially_failedfailedcancelled |
| source * | source | |
| created_at * | schema | |
| started_at | schema | |
| completed_at | schema | |
| progress * | object | |
| errors_url | string | |
| result_url | string | |
| idempotency_key * | string |
400
Validation, sort/filter, or window error.
object
| Field | Type | Description |
|---|---|---|
| errors * | object[] |
401
Missing/expired token, or scope missing.
schema
403
Forbidden (override required, scope insufficient, resource-level).
schema
409
Idempotency conflict or invalid state transition.
schema
422
Schema validation failed.
schema
429
Rate limit exceeded. See Retry-After + RateLimit-* headers.
schema
Example request
POST https://api.digitalonboarding.com/v2/batch/operations
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }