Agendize Client API

Batch

On February 28th, 2021 we released the version 2.3 of the Batch API. the previous version's documentation is still available here.


Resource representation

{ requests: [ { path: {string}, method: {string}, body: {object}, name: {string}, headers: {object} } ] }
Parameter name Value Description
requests[] list Batch operations.
requests[].path string Path request of the API operation (e.g: "/api/2.0/scheduling/companies").
requests[].method string Method of the API operation. Values: "POST", "GET", "DELETE", "UPDATE"
requests[].body string Body object of the operation.
requests[].name string Name of the operation. Uses it to rrequest ressult properties in an other request.
requests[].headers string Http headers of the operation. For example to define different api credentials than the batch request.

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 (e.g: "/api/2.0/scheduling/companies").
requests[].method boolean Method of the API operation. Values: "POST", "GET", "DELETE", "UPDATE"
requests[].body string Body object of the operation.
requests[].name string Name of the operation. Uses it to rrequest ressult properties in an other request.
requests[].headers string Http headers of the operation. For example to define different api credentials than the batch request.

Response

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

{ responses: [ { path: {string}, method: {string}, body: {string}, status: {integer}, name: {string}, responses: [ {object} ], "contentType: {string}, duration: {integer} } ] }

With the following properties:

Parameter name Value Description
Required Properties
responses[] list Batch operations responses.
responses[].path object Path request of the API operation (e.g: "/api/2.0/scheduling/companies").
responses[].method object Method of the API operation. Values: "POST", "GET", "DELETE", "UPDATE"
responses[].responses[] string Child responses.
responses[].status integer Status code of the response.
responses[].name string Name of the operation.
responses[].duration string Duration of the operation, in milliseconds