Agendize Client API

Notes


Resource representation

{ "id": {string}, "clientId": {string}, "html": {string}, "writer": { "email": {string}, "firstName": {string}, "lastName": {string} }, "date": { "dateTime": {datetime}, "timeZone": {string} }, "selfLink": {string}, "contactedByClient": (boolean) }
Parameter name Value Description
id string Identifier of the note.
clientId string Identifier of the client. Max length: 16.
html string Html content of the note. Max length: 65535.
date object The date time of the note.
start.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
start.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.
writer object Writer of the notes.
writer.email string Account email of the user. Max length: 255.
writer.firstName string First Name of the user. Max length: 255.
writer.lastName string Last Name of the user. Max length: 255.
selfLink string URL link to the note resource description.
contactedByClient boolean Manual update of the last consent date

Delete

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/notes/{noteId}

Parameters

Parameter name Value Description
Path parameters
noteId string Note identifier.
Required query parameters
apiKey string API Key

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


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/notes/{noteId}

Parameters

Parameter name Value Description
Path parameters
noteId string Note identifier.
Required query parameters
apiKey string API Key

Request body

Do not supply a request body with this method.

Response

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


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/notes

Parameters

Parameter name Value Description
Required query parameters
apiKey string API Key
Optional query parameters
clientId string Identifier of the client.

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: [Note Resource] }

Insert

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

Request

HTTP Request

POST https://api.agendize.com/api/2.0/notes

Parameters

Parameter name Value Description
Required query parameters
apiKey string API Key

Request body

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

Parameter name Value Description
Required Properties
clientId string Identifier of the client.
html string Html content of the note.
Optional Properties
writer object Writer of the notes.
writer.email string Account email of the user.
contactedByClient boolean Manual update of the last consent date

Response

If successful, this method returns a Note 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/notes/{noteId}

Parameters

Parameter name Value Description
Path parameters
noteId string Note identifier.
Required query parameters
apiKey string API Key

Request body

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

Parameter name Value Description
Optional Properties
html string Html content of the note.
writer object Writer of the notes.
writer.email string Account email of the user.

Response

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


Watch

Watch for changes to notes.

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

The watch send a Note resource in the request body

Request

HTTP Request

POST https://api.agendize.com/api/2.0/notes/watch

Request body

{ "address": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { (name): {string} }, "schema": {object} }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
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.

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

  • Note added in dashboard. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: created
  • Note modified in dashboard. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: updated
  • Note delete in dashboard. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: deleted