batches

Update a batch

Updates the metadata for a specific batch.

patch/v1/batches/{batchId}

Request

  • Base URL: https://api.olostep.com
  • URL: https://api.olostep.com/v1/batches/{batchId}
  • Auth: HTTP bearer

Path parameters

batchIdstring required

Request body

metadataobject required

Set of up to 50 key-value string pairs you can attach to the object. Echoed back unchanged.

Response

Default Response

idstring required
object'batch' required
statusstring required
creatednumber required
completed_atnumber nullable
total_urlsinteger required
completed_urlsinteger required
number_retriedinteger
parserstring nullable
countrystring nullable
start_datestring
metadataobject
webhookstring nullable
completion_windowstring
credits_consumednumber nullable
cost_usdnumber nullable
warningstring

Changes

No recorded changes to this operation across all 3 revisions of this API.