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:

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:

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.

{
  "webhookInterval": 50
}