For an overview of how to make batch API requests, see batch requests.
Batch
A response object returned from a batch request.
Property | Type | Description |
---|---|---|
body | object | The JSON body that the invoked endpoint returned. |
headers | object | A map of HTTP headers specific to this result. This is primarily used for returning a Location header to accompany a 201 Created result. The parent HTTP response will contain all common headers. |
status_code | integer | The HTTP status code that the invoked endpoint returned. |
{
"body": {
"data": {
"completed": false,
"gid": "1967",
"name": "Hello, world!",
"notes": "How are you today?"
}
},
"headers": {
"location": "/tasks/1234"
},
"status_code": 200
}