Agendize Client API

Form results notes


On January 2021 we released the version 2.3 of the FormBuilder API. This new version includes performance improvements and a better respect of HTTP protocol for RestFull APIs. All v2.0 URIs of the FormBuilder API are available in v2.3. If you are currently using the v2.0 of the FormBuilder API, we encourage you to update to the newer version. The new documentation is available here here.

Resource representation

{ "id": {string}, "html": {string}, "writer": { "email": {string}, "firstName": {string}, "lastName": {string} }, "date": { "dateTime": {datetime}, "timeZone": {string} } }
Parameter name Value Description Notes
id string Identifier of the note.
html string Html content of the note. Max length: 65535. writable
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.

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/forms/{formId}/results/{resultId}/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/forms/{formId}/results/{resultId}/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/forms/{formId}/results/{resultId}/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/forms/{formId}/results/{resultId}/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.
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.

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/forms/{formId}/results/{resultId}/notes/{noteId}

Parameters

Parameter name Value Description
Path parameters
clientId 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.