Agendize Client API

Batch


Resource representation

{ requests: [ { path: {string}, method: {string}, body: {object} } ] }
Parameter name Value Description
requests[] list Batch operations.
requests[].path string Path request of the API operation.
requests[].method string Method of the API operation. Values: "POST", "GET", "DELETE", "UPDATE"
requests[].body string Body object of the operation.

Send operations

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/api/2.0/batch

Request body

In the request body, supply a list of operations with the following properties:

Parameter name Value Description
Required Properties
requests[] list Batch operations.
requests[].path string Path request of the API operation.
requests[].primary boolean Method of the API operation. Values: "POST", "GET", "DELETE", "UPDATE"
requests(] string Body object of the operation.

Response

If successful, this method returns a response content in the response body:

{ responses: [ { path: {string}, method: {string}, body: {string}, status: {integer}, } ] }

With the following properties:

Parameter name Value Description
Required Properties
responses[] list Batch operations responses.
responses[].path object Body object of the response.
responses[].method object Method of the API operation. Values: "POST", "GET", "DELETE", "UPDATE"
responses[].response string Body object of the response.
responses[].status integer Status code of the response.