Claude Platform Docs

Delete a Message Batch

$ ant messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}

Delete a Message Batch.

Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it.

Learn more about the Message Batches API in our user guide

Parameters
--message-batch-id: string⁠Path parameter

ID of the Message Batch.

--workspace-id: optional string⁠Header parameter

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
deleted_message_batch: object{ type: "message_batch_deleted", id }
type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

id: string

ID of the Message Batch.

Errors

Any method can also return the general HTTP errors.

Each code below is the value of error.details.error_code in the response body.

error code claude_code_key_creator_not_memberHTTP status 400

The API key belongs to the Claude Code workspace, and the user who created it is no longer a member of the organization or of that workspace.

error code organization_on_holdHTTP status 400

Anthropic has disabled the organization for trust and safety reasons. An organization disabled for any other reason, such as billing, does not get this code. appeal_url, when present, is where the organization can appeal.

Delete a Message Batch
ant messages:batches delete \
  --message-batch-id message_batch_id
Returns Examples
Response 200
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}