v2

latestOpenAPI 3.1.02026-08-06276982.8 KB
batches

Poll batches job

Poll the asynchronous job created when deleting a batch.

<Info>This API operation and SDK method are maintained for backward compatibility, but the functionally identical API operation poll file operation job status and its corresponding SDK method client.jobs.status() are preferred.</Info>

get/v2/batches/jobs/{job_id}

Path parameters

job_idstring required

The job ID returned by a Delete batch request.

Headers

Authorizationstring required

Bearer HTTP authentication.

IB-Contextstring

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

Response

Request successful

state'COMPLETE' | 'FAILED' | 'CANCELLED' | 'RUNNING' | 'PENDING'

The status of the job.

messagestring

Job status message.