Execute bulk process
/bulks/{bulk_id}/execute Starts execution of the bulk process identified by the bulk_id parameter.
A bulk process is created by one of the bulk operations
(creating users, sends, transfers, or wire transfers, blocking cards, and so on) and sits in
SUBMITTED until you execute it. Nothing runs until this call.
The process must be in SUBMITTED; calling it in any other state fails with INVALID_STATE, and
calling it twice fails with ALREADY_SUBMITTED.
Fields
mode decides what happens when an individual operation fails:
| Mode | Effect |
|---|---|
ON_FAILURE_STOP | Execution stops at the first operation that returns a 4xx or 5xx. |
ON_FAILURE_CONTINUE | Execution carries on through failures and reports them at the end. |
webhookInterval is the number of operations between Bulk Process Progress webhooks. The effective
minimum is 25% of the total, so a smaller value still yields four webhooks across the run.
It returns immediately
Execution is asynchronous: a 204 means the run was accepted, not that it finished. The process moves
to RUNNING and settles on one of:
| Final state | Meaning |
|---|---|
COMPLETED | Every operation succeeded. |
PARTIALLY_COMPLETED | Execution finished, but some operations failed. |
FAILED | No operation executed. |
CANCELLED | The run was canceled before finishing. |
Track it with Get bulk process, and find which individual
operations failed with List bulk operations, filtering on
status.
Controlling a run
While RUNNING, you can pause the process and later
resume it, or
cancel it. Canceling is final. Operations that have already
executed aren't rolled back by either.
Read The bulk process for the full lifecycle.
Request
Path parameters
Request body
*Responses
Success - No Content.