Agendize Platform API

Accounts API Reference

The Permissions API allow to define and get permissions of other users on an user account.


Resource representation

{ "emailAddress": {string), "acls": [ { "role": {string}, "target": {string} } ] }
Parameter name Value Description
emailAddress string Username / Email address of the user account.
acls string List of permissions for the user account.
acls[].role object User role. values are:
  • accountAnalytics
  • chatAdministrator
  • chatOperator
  • schedulingAdministrator
  • schedulingStaff
  • schedulingRead
  • testimonialsModeration
  • accountBilling
  • accountButtons
  • accountEmails
  • accountCalls
  • accountForms
  • accountCRM
  • accountSchedulingAdministrator
  • accountSchedulingSchedule
  • accountSchedulingRead
  • queue

List

Returns entries on the reseller's account list.

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

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/accounts/permissions

Parameters

Parameter name Value Description
Optional query parameters
role string Gets permissions for a specific role.

Request body

Do not supply a request body with this method.

Response

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


Permissions: patch

Add user permissisons to an main account.

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

Request

HTTP Request

PATCH http://az2.agendize.com/api/2.0/platform/accounts

Request body

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

Parameter name Value Description
Required Properties
acls string List of permissions for the user account.
acls[].role object User role. values are:
  • accountAnalytics
  • chatAdministrator
  • chatOperator
  • schedulingAdministrator
  • schedulingStaff
  • schedulingRead
  • testimonialsModeration
  • accountBilling
  • accountButtons
  • accountEmails
  • accountCalls
  • accountForms
  • accountCRM
  • accountSchedulingAdministrator
  • accountSchedulingSchedule
  • accountSchedulingRead
  • queue

Response

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


Watch

Watch for changes to users permissions.

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

The watch send an Permissions resource in the request body

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/accounts/permissions/watch

Parameters

companyId string Company identifier.

Request body

{ "id": {string}, "address": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { (name): {string} } }
id string Identifier of the watch.
address string The address where notifications are delivered for this watch.
basicAuth string Credentials parameters for HTTP Basic authentication. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Username.
httpRequestHeader string Custom header parameters to send with the http request.
httpRequestHeader.name string header parameter name.

Response

If successful, this method returns an of Watch resource in the response body.