API referenceBatches

Delete batch

Delete a batch and all its files. This is an asynchronous operation that must be checked for completion.

Authentication

AuthorizationBearer
Bearer HTTP authentication.

Path parameters

batch_idintegerRequired
The batch ID.

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](/api-sdk/authorization#ib-context-header) for details.

Response

Batch deletion request accepted. Poll the job ID to check completion status.

job_idstring

The job ID of the operation. Use the job ID with the Poll batches job endpoint to check batch deletion status.

Errors