Update batch metadata

Updates user-defined metadata fields for the batch with provided id. This includes the webhook_url. Explicitly passing an empty string for webhook_url to the request body will remove/clear any webhook url from the batch.

Authorizations

x-api-key

string

headerrequired

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.

Response

200 - application/json

status

enum<string>

required

Available options:

success,

error

data

object

required

Show child attributes

message

string

required

error

object

Show child attributes