Poll batches job

GET

Poll the asynchronous job created when deleting a batch or deleting a file from a batch.

Path parameters

job_idstringRequired

The job ID returned by a Delete batch request or the Location header value returned by a Delete file from a batch request.

Headers

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Response

This endpoint returns an object.
stateenumOptional
Allowed values: COMPLETEFAILEDCANCELLEDRUNNINGPENDING

The status of the job.

messagestringOptional

Job status message.