Agendize Developers API

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}, "menuBackgroundColor": {string} }, "clientName": {string}, "status": {string}, "sendSignupEmail": {boolean}, "additionalUsers": {integer}", "tags": [ { "id": {string}, "tag": {string}, "color": {string} } ] }
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. Max length: 255.
lastName string Last name of the user account. Max length: 255.
email string Email address of the user account. Used as user name, it is not possible to change after account creation. Max length: 255.
password string Password of the user account. Work only with insert and update methods. Max length: 63.
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. Max length: 63.
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. Max length: 63.
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,call
whiteLabel object White label settings of the user account.
whiteLabel.logoURL string White label Logo of the user account. Max length: 255.
whiteLabel.emailAddress string White label email address of the user account. Max length: 255.
whiteLabel.headerBackgroundColor string White label header background color.
whiteLabel.menuBackgroundColor string White label left menu 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 boolean If "true" send email signup to account.
additionalUsers object Number of user accounts in addition to the plan.
tags[] list Tags of the user account.
tags[].id string Identifier of the tag. Read-only
tags[].tag string Text of tag. Max length: 255.
tags[].color boolean Color of tag. Web format (#xxxxxx)

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 https://api.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 https://api.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 https://api.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 https://api.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.
profile.id string Identifier of the account profile.
Optional Properties
lastName string Last name of the user account.
firstName string First name of the user account.
sendSignupEmail boolean Send a signup email to user to set his password.
tags[].tag string Text of tag. Max length: 255.
tags[].color boolean Color of tag. Web format (#xxxxxx)

Response

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

Patch

Add values in arrays of properties of an account entry. Only properties listed bellow are supported

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

Request

HTTP Request

PATCH https://api.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
tags[].id string Identifier of the tag.
tags[].color boolean Color of tag. Web format (#xxxxxx)

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 https://api.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.
tags[].tag string Text of tag. Max length: 255.
tags[].color boolean Color of tag. Web format (#xxxxxx)

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

Request body

{ "address": {string}, "name": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { {name}: {string} }, "schema": {object}, "addPreviousData": {boolean} "method": {string}, "status": {string}, "oauth2Auth": { "grantType": {string}, "clientId": {string}, "clientSecret": {string}, "refreshToken": {string}, "authUrl": {string}, "accessTokenUrl": {string}, "redirectUri": {string} }, "signature": { "enabled": {boolean}, "cryptoKeyIds": [ {string} ] } }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
name string Name of the watch.
basicAuth string Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Password.
httpRequestHeader string Custom header parameters to send with the http request on the destination watch address.
httpRequestHeader.name string header parameter name.
schema object Custom json schema to apply for resource properties.
addPreviousData boolean Add data of the previous version of the resource.
method string HTTP Method to use for sending content. DELETE Method doesn't accept body content.
status string Status of the watcher. Values: "enabled", "disabled"
oauth2Auth string Credentials parameters for HTTP OAuth2 authentication on the destination watch address. Only if you use this authentication method.
oauth2Auth.grantType string OAuth2 grant type. Values: "refresh_token" (default), "client_credentials".
oauth2Auth.clientId string OAuth2 client id.
oauth2Auth.refreshToken string OAuth2 refresh token. Only for grantType "refresh_token"
oauth2Auth.authUrl string OAuth2 interactive end point to initiate the generation of the refresh token. Only for grantType "refresh_token"
oauth2Auth.accessTokenUrl string OAuth2 end point to generation an access token from the refresh token.
oauth2Auth.scope string OAuth2 api scope. Only for grantType "refresh_token"
signature object Produces a crypto signature of the watched content.
signature.enabled boolean Sets if the signature is enabled or not.
signature.cryptoKeyIds list Arrays of string of crypto keys identifier.

Response

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

Examples of schema:

With JSON, only for string value:

{ "schema": { "my_id_key": "{id}", "dataContent": { "givenName": "{firstName}" } } }

With string to support typed values:

{ "schema": "\"my_id_key\": ${$.id}, \"dataContent\": { \"fullName\": \"${$.firstName} ${$.lastName}\"}" }

Replacement string can by defined with jsonpath expressions.

Watch event supported

  • Account added in reseller console or account created by API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: created
  • Account modified by API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: updated

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.