Skip to navigation
API referenceBatches

Poll batches job

Poll the asynchronous job created when deleting a batch.

This endpoint and the SDK method client.batches.poll_job() are maintained for backward compatibility, but they are an outdated way to check job status. Prefer the functionally identical poll file operation job status endpoint and its SDK method client.jobs.status().

Authentication

AuthorizationBearer
Bearer HTTP authentication.

Path parameters

job_idstringRequired

The job ID returned by a Delete batch request.

Headers

IB-ContextstringOptional

Typically your organization ID. See Authorization and context identification for details.

Response

Request successful
stateenumOptional
The status of the job.
Allowed values:
messagestringOptional
Job status message.