Batches

Delete a batch

Changed on

Permanently delete a finished batch and its results. Its webhook deliveries can no longer be retried.

delete/batch/{batch_id}

Request

  • Base URL: https://api.context.dev/v1
  • URL: https://api.context.dev/v1/batch/{batch_id}
  • Auth: HTTP bearer

Path parameters

batch_idstring required

Batch ID.

Example:batch_9f2c8a

Response

Batch and its stored results are permanently deleted.

idstring

ID of the deleted batch.

deletedboolean

Always true on success.

request_idstring uuid required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example response

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"
}

Changes

  • 61627728926bRevision changes
    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

  • 4ddcf49b9fe5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status