Skip to main content

Set metadata

Only one of batchId or label may be provided at a given time. Otherwise an error occurs.

Query Parameters
batchId uuid

The id of the batch

Example: 11112222-3333-4444-5555-666677778888

label string

The label

Example: &ABCD1234

Request Body

The metadata to persist

value string

The metadata for the batch or label

Responses
200

Success

Schema OPTIONAL
object

Wraps a nonexistent value to always have a json object in the request/response body

400

An error describing the issue caused by the client

Schema OPTIONAL
type int32 OPTIONAL

Possible values: [0, 1, 2, 3, 4]

The type of client error

message string OPTIONAL

The error message

500

An error describing the server issue

Schema OPTIONAL
message string OPTIONAL

The error message