Skip to main content
PUT
Update batch metadata

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Body

application/json
webhook_url
string

Webhook url to send data to upon batch completion. Provide an empty string to clear any existing webhook url assigned to the batch execution.

Example:

"https://api.example.com/updated-webhook/batch-results"

Response

Successfully updated batch with provided id

status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
object
required
message
string
required
error
object