Agendize Developers API

Home > Agendize Scheduling

General Settings

Resource representation

{ "roles": { "schedulingAdministrator": { "appointmentsAccess": {string}, "appointmentsAccept": {boolean}, "appointmentsSchedule": {boolean}, "appointmentsReschedule": {boolean}, "clientsList": {boolean}, "appointmentsStatusChange": {boolean}, "clientsEdit": {boolean}, "appointmentsModeFree": {boolean}, "settingsCompany": {boolean}, "settingsServices": {boolean}, "settingsStaff": f{boolean}, "settingsResources": {boolean}, "settingsProcess": {boolean}, "settingsWidget": {boolean}, "settingsNotifications": {boolean}, "settingsPayments": {boolean}, "settingsMessages": {boolean}, "settingsCalendars": {boolean}, "settingsCrm": {boolean} }, "schedulingSchedule": { "appointmentsAccess": {string}, "appointmentsAccept": {boolean}, "appointmentsSchedule": {boolean}, "appointmentsReschedule": {boolean}, "clientsList": {boolean}, "appointmentsStatusChange": {boolean}, "clientsEdit": {boolean}, "appointmentsModeFree": {boolean}, "settingsCompany": {boolean}, "settingsServices": {boolean}, "settingsStaff": f{boolean}, "settingsResources": {boolean}, "settingsProcess": {boolean}, "settingsWidget": {boolean}, "settingsNotifications": {boolean}, "settingsPayments": {boolean}, "settingsMessages": {boolean}, "settingsCalendars": {boolean}, "settingsCrm": {boolean} }, "schedulingRead": { "appointmentsAccess": {string}, "appointmentsAccept": {boolean}, "appointmentsSchedule": {boolean}, "appointmentsReschedule": {boolean}, "clientsList": {boolean}, "appointmentsStatusChange": {boolean}, "clientsEdit": {boolean}, "appointmentsModeFree": {boolean}, "settingsCompany": {boolean}, "settingsServices": {boolean}, "settingsStaff": f{boolean}, "settingsResources": {boolean}, "settingsProcess": {boolean}, "settingsWidget": {boolean}, "settingsNotifications": {boolean}, "settingsPayments": {boolean}, "settingsMessages": {boolean}, "settingsCalendars": {boolean}, "settingsCrm": {boolean} }, }, "i18n": { languages: [ { "code": {string}, "displayName": {string} } ] }
Parameter name Value Description
roles string The group of settings.
roles.schedulingAdministrator string Rights for administrator role.
roles.schedulingAdministrator.appointmentsAccess string Level access for appointments. Values: "all", "personals"
roles.schedulingAdministrator.appointmentsAccept boolean Can accept or decline appointments.
roles.schedulingAdministrator.appointmentsSchedule boolean Can schedule new appointments.
roles.schedulingAdministrator.appointmentsReschedule boolean Can reschedule appointments/
roles.schedulingAdministrator.clientsList boolean Can access the client list.
roles.schedulingAdministrator.appointmentsStatusChange boolean Can update appointment status.
roles.schedulingAdministrator.clientsEdit boolean Can add or edit clients.
roles.schedulingAdministrator.appointmentsModeFree boolean Can use the free mode to schedule or reschedule an appointment.
roles.schedulingAdministrator.settingsCompany boolean Can change company settings.
roles.schedulingAdministrator.settingsServices boolean Can change services settings.
roles.schedulingAdministrator.settingsStaff boolean Can change staff settings.
roles.schedulingAdministrator.settingsResources boolean Can change resources settings.
roles.schedulingAdministrator.settingsProcess boolean Can change process settings.
roles.schedulingAdministrator.settingsWidget boolean Can change widget settings.
roles.schedulingAdministrator.settingsNotifications boolean Can change notifications settings.
roles.schedulingAdministrator.settingsPayments boolean Can change online payments settings.
roles.schedulingAdministrator.settingsCalendars boolean Can change calendar sync settings.
roles.schedulingAdministrator.settingsCrm boolean Can change mailing list & CRM settings.
roles.schedulingSchedule string Rights for schedule role.
roles.schedulingSchedule.appointmentsAccess string Level access for appointments. Values: "all", "personals"
roles.schedulingSchedule.appointmentsAccept boolean Can accept or decline appointments.
roles.schedulingSchedule.appointmentsSchedule boolean Can schedule new appointments.
roles.schedulingSchedule.appointmentsReschedule boolean Can reschedule appointments/
roles.schedulingSchedule.clientsList boolean Can access the client list.
roles.schedulingSchedule.appointmentsStatusChange boolean Can update appointment status.
roles.schedulingSchedule.clientsEdit boolean Can add or edit clients.
roles.schedulingSchedule.appointmentsModeFree boolean Can use the free mode to schedule or reschedule an appointment.
roles.schedulingSchedule.settingsCompany boolean Can change company settings.
roles.schedulingSchedule.settingsServices boolean Can change services settings.
roles.schedulingSchedule.settingsStaff boolean Can change staff settings.
roles.schedulingSchedule.settingsResources boolean Can change resources settings.
roles.schedulingSchedule.settingsProcess boolean Can change process settings.
roles.schedulingSchedule.settingsWidget boolean Can change widget settings.
roles.schedulingSchedule.settingsNotifications boolean Can change notifications settings.
roles.schedulingSchedule.settingsPayments boolean Can change online payments settings.
roles.schedulingSchedule.settingsCalendars boolean Can change calendar sync settings.
roles.schedulingSchedule.settingsCrm boolean Can change mailing list & CRM settings.
roles.schedulingRead string Rights for read role.
roles.schedulingRead.appointmentsAccess string Level access for appointments. Values: "all", "personals"
roles.schedulingRead.appointmentsAccept boolean Can accept or decline appointments.
roles.schedulingRead.appointmentsSchedule boolean Can schedule new appointments.
roles.schedulingRead.appointmentsReschedule boolean Can reschedule appointments/
roles.schedulingRead.clientsList boolean Can access the client list.
roles.schedulingRead.appointmentsStatusChange boolean Can update appointment status.
roles.schedulingRead.clientsEdit boolean Can add or edit clients.
roles.schedulingRead.appointmentsModeFree boolean Can use the free mode to schedule or reschedule an appointment.
roles.schedulingRead.settingsCompany boolean Can change company settings.
roles.schedulingRead.settingsServices boolean Can change services settings.
roles.schedulingRead.settingsStaff boolean Can change staff settings.
roles.schedulingRead.settingsResources boolean Can change resources settings.
roles.schedulingRead.settingsProcess boolean Can change process settings.
roles.schedulingRead.settingsWidget boolean Can change widget settings.
roles.schedulingRead.settingsNotifications boolean Can change notifications settings.
roles.schedulingRead.settingsPayments boolean Can change online payments settings.
roles.schedulingRead.settingsCalendars boolean Can change calendar sync settings.
roles.schedulingRead.settingsCrm boolean Can change mailing list & CRM settings.
i18n object Internationalization parameters. writable
i18n..languages list Available languages. writable
i18n.languages.code string ISO_639-1 language codes. writable
i18n.languages.displayName string Language's display name.

Get

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

Request

HTTP Request

GET https://api.agendize.com/api/2.0/scheduling/accountSettings

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ Settings resource }

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/scheduling/accountSettings

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

In the request body, supply a list of Setting resource

Response

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

Agendize | Support | Status

Last update: Sep 28, 2021 - Copyright © 2021 Agendize. All rights reserved.