Skip to main content
PATCH
Change a batch's priority or pacing

Authorizations

X-API-Key
string
header
required

Path Parameters

batch_id
string
required

Body

application/json

Change a batch that is still queued or in flight.

priority re-orders the batch's remaining work within its own dispatch lane; work already sent is untouched. pacing sets or replaces the release policy and applies from the next release tick — slowing a batch down never recalls work already released, and speeding one up never produces a burst to make up the difference. To stop pacing a batch entirely send remove_pacing: true rather than a null pacing.

Every field is optional; send only what you are changing.

priority
enum<string> | null
Available options:
normal,
high
pacing
BatchPacingPolicyIn · object | null

A ceiling on how fast a batch is released: N records every M minutes.

The rate is a hard ceiling over any interval — there is no catch-up burst. After a pause, an exhausted provider quota or a closed delivery window, delivery resumes at the configured rate from that moment and the lost time is not made up.

period_minutes is a whole number of minutes; pacing finer than a minute cannot be expressed. Add a window to confine delivery to particular local hours. Released records are ordinary queue work: they may still be merged with other batches' work bound for the same destination, but this batch never delivers faster than its policy allows.

Example:
remove_pacing
boolean
default:false

Response

Successful Response

id
string
required
definition_id
string
required
org_id
string
required
trigger_id
string
required
trigger_type
string
required
metadata
Metadata · object
required
status
enum<string>
required
Available options:
pending,
queued,
scheduled,
running,
paused,
completed,
completed_with_errors,
partially_failed,
failed,
cancelled
record_count
integer
required
scheduled_at
string<date-time> | null
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
trigger_source
string | null
schedule_id
string | null
priority
enum<string> | null
Available options:
normal,
high
pacing
PacingPolicy · object | null

A ceiling on how fast a batch may be released: N records every M minutes.

The rate is a hard ceiling over any interval — there is no catch-up burst. After a pause, an exhausted provider quota or a closed delivery window, delivery resumes at the configured rate from that moment; the time lost is not made up.

period_minutes is measured in whole minutes: pacing finer than a minute cannot be expressed. Add a window to confine delivery to particular local hours.