Home > Agendize Scheduling

Scheduling settings


Resource representation

{ "widget": { "schedulingSMS": {boolean}, "onboarding": {boolean}, "javascript": {string}, "css": {string} }, "staffForm": { "title-mandatory": {boolean}, "firstname-mandatory": {boolean}, "lastname-mandatory": {boolean}, "gender-mandatory": {boolean}, "email-mandatory": {boolean}, "mobilePhone-mandatory": {boolean}, "otherPhone-mandatory": {boolean}, "description-mandatory": {boolean}, "title": {string}, "fields": [ { "id": {string}, "type": {string}, "title": {string}, "mandatory": {boolean}, "otherValue": {boolean}, "category": {boolean}, "multiple": {boolean}, "values": [ { "id": {string}, "name": {string}, "value": {string} }, { id": {string}, "name": {string} "values": [ { "id": {string}, "name": {string}, "value": {string} } ] } ] } ] } }
Parameter name Value Description
widget object Reseller scheduling settings
widget.schedulingSMS boolean Activate or unactivate SMS features: notifications and reminders.
widget.onboarding string Activate or unactivate onboarding.
widget.javascript string Additional javascript code to include in widget pages.
widget.css string Additional css code to include in widget pages.
staffForm object Reseller scheduling staff fields settings
staffForm.title-mandatory boolean Set the field Title required in the staff form (default false).
staffForm.firstname-mandatory boolean Set the field Firstname required in the staff form (default false).
staffForm.lastname-mandatory boolean Set the field Lastname required in the staff form (default true).
staffForm.gender-mandatory boolean Set the field Gender required in the staff form (default false).
staffForm.email-mandatory boolean Set the field Email required in the staff form (default false).
staffForm.mobilePhone-mandatory boolean Set the field Mobile Phone required in the staff form (default false).
staffForm.otherPhone-mandatory boolean Set the field Other Phone required in the staff form (default false).
staffForm.description-mandatory boolean Set the field Description required in the staff form (default false).
staffForm.title string Title of the additional field area.
staffForm.fields list List of scheduling staff fields.
staffForm.fields[].id string Identifier of scheduling staff field.
staffForm.fields[].type string Type of scheduling staff field (input, textarea, radio, checkbox, select).
staffForm.fields[].title string Title of scheduling staff field
staffForm.fields[].mandatory boolean Set the scheduling staff field mandatory.
staffForm.fields[].otherValue boolean Activate or deactivate the possibility to add a custom value to the field. Available for type radio, checkbox and select.
staffForm.fields[].category boolean Activate or deactivate the possibility to group values by category. Available only for type select.
staffForm.fields[].multiple boolean Activate or deactivate the possibility to select several values. Available only for type select.
staffForm.fields[].values list List of values. Available for type radio, checkbox and select.
staffForm.fields[].values[].id string Identifier of the staff field value.
staffForm.fields[].values[].name string Name of the staff field value.
staffForm.fields[].values[].value string Value of the staff field value.
staffForm.fields[].values[].values list List of values of the staff field value. Available only for type select with option category set to True
staffForm.fields[].values[].values[].id string Identifier of the staff field value. Available only for type select with option category set to True
staffForm.fields[].values[].values[].name string Name of the staff field value. Available only for type select with option category set to True
staffForm.fields[].values[].values[].value string Value of the staff field value. Available only for type select with option category set to True

Get

Returns an entry of the company's resource list.

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

Request

HTTP Request

GET https://api.agendize.com/api/2.0/resellers/settings/scheduling

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 https://api.agendize.com/api/2.0/resellers/settings/scheduling

Request body

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

Parameter name Value Description
widget.schedulingSMS boolean Activate or unactivate SMS features: notifications and reminders.
widget.onboarding string Activate or unactivate onboarding.
widget.javascript string Additional javascript code to include in widget pages.
widget.css string Additional css code to include in widget pages.
staffForm object Reseller scheduling staff fields settings
staffForm.title-mandatory boolean Set the field Title required in the staff form (default false).
staffForm.firstname-mandatory boolean Set the field Firstname required in the staff form (default false).
staffForm.lastname-mandatory boolean Set the field Lastname required in the staff form (default true).
staffForm.gender-mandatory boolean Set the field Gender required in the staff form (default false).
staffForm.email-mandatory boolean Set the field Email required in the staff form (default false).
staffForm.mobilePhone-mandatory boolean Set the field Mobile Phone required in the staff form (default false).
staffForm.otherPhone-mandatory boolean Set the field Other Phone required in the staff form (default false).
staffForm.description-mandatory boolean Set the field Description required in the staff form (default false).
staffForm.title string Title of the additional field area.
staffForm.fields list List of scheduling staff fields.
staffForm.fields[].id string Identifier of scheduling staff field.
staffForm.fields[].type string Type of scheduling staff field (input, textarea, radio, checkbox, select).
staffForm.fields[].title string Title of scheduling staff field
staffForm.fields[].mandatory boolean Set the scheduling staff field mandatory.
staffForm.fields[].otherValue boolean Activate or deactivate the possibility to add a custom value to the field. Available for type radio, checkbox and select.
staffForm.fields[].category boolean Activate or deactivate the possibility to group values by category. Available only for type select.
staffForm.fields[].multiple boolean Activate or deactivate the possibility to select several values. Available only for type select.
staffForm.fields[].values list List of values. Available for type radio, checkbox and select.
staffForm.fields[].values[].id string Identifier of the staff field value.
staffForm.fields[].values[].name string Name of the staff field value.
staffForm.fields[].values[].value string Value of the staff field value.
staffForm.fields[].values[].values list List of values of the staff field value. Available only for type select with option category set to True
staffForm.fields[].values[].values[].id string Identifier of the staff field value. Available only for type select with option category set to True
staffForm.fields[].values[].values[].name string Name of the staff field value. Available only for type select with option category set to True
staffForm.fields[].values[].values[].value string Value of the staff field value. Available only for type select with option category set to True

Response

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