Agendize Resellers API

Accounts


Resource representation

{ "id": {string}, "userName": {string}, "firstName": {string}, "lastName": {string}, "email": {string}, "password": {string}, "currency": {string}, "resellerId": {string}, "domain": {string}, "preferences": { "timeZone": {string}, "language": {string}, "displayName": {string} }, "credit": {float}, "created": { "dateTime": {datetime}, "timeZone": {string} }, "ssoToken": {string}, "profile": { "id": {string}, "name": {string} } "tools": [ {string} ] 'whiteLabel": { "logoURL": {string}, "emailAddress": {string}, "headerBackgroundColor" : {string} }, "clientName": {string}, "status": {string}, "sendSignupEmail": {boolean} }
Parameter name Value Description
id string Identifier of the user account. Read-only
userName string user name of the user account. The same value as the email address. Read-only
firstName string First name of the user account.
lastName string Last name of the user account.
email string Email address of the user account. Used as user name, it is not possible to change after account creation.
password string Password of the user account. Work only with insert and update methods
organization string The name of the organization of the user account.
preferences object Profile settings of the user account.
preferences.timeZone string Time zone code of the user account. Possible values can be found here.
preferences.language string Spoken language of the user account.
preferences.displayName string Name of the user account. Default: email address of the user account.
currency string Currency of the user account. Values: "USD", "CAD", "EUR", "GBP" or "JPY".
resellerId string Internal reseller client identifier. Has to be unique for each client account.
domain string Url domain of the reseller. If not set will be forced based on the reseller domain if set or API call url domain.
created object The created time of the user account.
created.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
created.timeZone string The time zone code. Possible values can be found here. The default value is the time zone of the company.
ssoToken string The SSO token to use to connect to API with the user account. Read-only
credit float Account credits. Read-Only
profile object The account profile type of the user account.
profile.id string Identifier of the account profile.
profile.name string Name of the account profile.
tools[] list List of tools availables for the user account. Values: save,scheduling,chat,call
whiteLabel object White label settings of the user account.
whiteLabel.logoURL string White label Logo of the user account.
whiteLabel.emailAddress string White label email address of the user account.
whiteLabel.headerBackgroundColor string White label header background color.
clientName object The account name of the user account. Displayed in the reseller console.
status object Status of the user account. Values: "enabled", "disabled".
sendSignupEmail object If "true" send email signup to account.

Delete

Deletes an entry on the reseller's account list.

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

Request

HTTP Request

DELETE http://az2.agendize.com/api/2.0/resellers/accounts/{accountId}

Parameters

Parameter name Value Description
Path parameters
accountId string Account identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Returns an entry of 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/resellers/accounts/{accountId}

Parameters

Parameter name Value Description
Path parameters
accountId string Account identifier or resellerId or userName.

Request body

Do not supply a request body with this method.

Response

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


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/resellers/accounts

Parameters

Parameter name Value Description
Optional query parameters
search string Search accounts by first name, last name, phone number and email address. Incompleted value can by used.
tools string Select accounts who have a specific list of tools activated. Values: "scheduling", "call", "callTracking".
status string Select accounts by status. Values: "enabled", "disabled".
createdStartDate datetime Upper bound (exclusive) for an account's creation time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by creation time.
createdEndDate datetime Lower bound (exclusive) for an account's creation time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by creation time.

Request body

Do not supply a request body with this method.

Response

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

{ items: [Account Resource] }

Insert

Adds an entry to the resellers's account list.

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

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/resellers/accounts

Request body

In the request body, supply a Account Resource with the following properties:

Parameter name Value Description
Required Properties
email string Email address of the user account.
Optional Properties
lastName string Last name of the user account.
firstName string First name of the user account.
sendSignupEmail string Send a signup email to user to set his password.

Response

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


Update

Updates an entry on the reseller's account list.

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

Request

HTTP Request

PUT http://az2.agendize.com/api/2.0/resellers/accounts/{accountId}

Parameters

Parameter name Value Description
Path parameters
accountId string Account identifier.

Request body

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

Parameter name Value Description
Optional Properties
lastName string Last name of the user account.
firstName string First name of the user account.
email string Email address of the user account.

Response

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


Watch

Watch for changes to Account resources.

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

The watch send an Account resource in the request body

Request

HTTP Request

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

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

{ "id": {string}, "address": {string} }
Parameter name Value Description
id string Identifier of the watch.
address string The address where notifications are delivered for this watch.

Response

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