Agendize Client API

Settings

Resource representation

{ "additionalFields": { "title": {string}, "fields": [ { "id": {string}, "name": {string}, "index": {string}, "mandatory": {boolean} } ] } }
Parameter name Value Description
additionalFields string Additional fields for client details.
title string Title of additional fields in staff page.
fields list List of fields.
fields[].id string Identifier of the field.
fields[].name string Name of the field.
fields[].mandatory boolean The field is mandatory, or not.
fields[].index boolean Index order.

Get

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

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/clients/settings

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Settings resource in the response body.


Update

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

Request

HTTP Request

PUT http://az2.agendize.com/api/2.0/clients/settings

Request body

In the request body, supply a Settings resource with the following properties:

Parameter name Value Description
additionalFields string Additional fields for client details.
title string Title of additional fields in staff page.
fields list List of fields.
fields[].id string Identifier of the field.
fields[].name string Name of the field.
fields[].mandatory boolean The field is mandatory, or not.
fields[].index boolean Index order.

Response

If successful, this method returns a Settings resource in the response body.