BatchResponseSchema

The response to a batch request, containing the results of each individual request.

Note that the index of each response in the array corresponds to the index of the request in the original batch request. If stop_on_error is true, the response array will stop at the first error encountered.

successboolean

Indicates whether the batch operation was successful. This will be false if any of the individual requests failed and true if all requests were successful.

Example: true

results object[]

Array [

response_codeinteger

The HTTP status code of the response.

Example: 200

headersobject

A dictionary of headers returned by the server.

Example: {"Content-Type":"application/json"}

bodyobject

The body of the response, if any. This is only used for successful responses.

Example: {"id":123,"username":"john_doe@example.com","fullname":"John Doe"}

]

BatchResponseSchema

{
  "success": true,
  "results": [
    {
      "response_code": 200,
      "headers": {
        "Content-Type": "application/json"
      },
      "body": {
        "id": 123,
        "username": "john_doe@example.com",
        "fullname": "John Doe"
      }
    }
  ]
}