Agendize forms API

Forms


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. If needed, the previous version's documentation is still available here.

Resource representation

{ "id": {string}, "name": {string}, "title": {string}, "submitMessage": {string}, "fields": [ {FormItem object} ], "followUp": {boolean}, "emailNotifications": {boolean}, "emailNotificationsAddresses": [ {string} ], "clientEmailNotifications": {boolean}, "finalizeLater": {boolean}, "finalizeLaterEmailMessage": {string} }
Parameter name Value Description
id string Identifier of the form. Read-only
name string Name of the form. Max length: 255.
title string Title of the form. Max length: 255.
submitMessage string Message of the form after validation. Max length: 65535.
fields[] list Fields of the form.
followUp boolean Enable or disable follow up feature.
emailNotifications boolean Enable or disable account email notification.
emailNotifications array[string] List of email adresses to notify for each form filled.
clientEmailNotifications boolean Allow end user to receive an email when he fill a new form.
finalizeLater boolean Allow end user to finalized the form later.
finalizeLaterEmailMessage boolean Text message displayed when the end user come back to the form.

Additional representation : FormItem

{ "id": {string}, "type": {string}, "title": {string}, "bind": {string), "bindGroup": {string}, "externalId": {string} "help": {string}, "mandatory": {boolean}, "visible" : {boolean}, "otherValue": {boolean}, "category": {boolean}, "multiple": {boolean}, "value": {string}, "fileName": {string}, "values": [ { "id": {string), "name": {string}, "value": {string} "values": [ { "id": {string}, "name": {string}, "value": {string} } ] } ], "valueFormat": { "maxLength": {number}, "minLength": {number}, "regexType: {string}, "regexValue: {string}, "valueFormat": {string} }, "zonedDateTime": { "dateTime": {string}, "timeZone": {string} }, "subItem": [ {FormItem object} ] }
Parameter name Value Description Notes
FormItem.id string Id of the field. Can not be empty.
FormItem.type string Type of the field. Values:
  • "input": input text
  • "select": dropdown
  • "checkbox": check box
  • "radio": radio button list
  • "textarea": textaera
  • "title": text label
  • "file": file upload
  • "address": client full address
  • "date": date
  • "rating": rating range from 1 to 5
  • "number": number field
  • "pricing": number field with currency
FormItem.title string Title of the field.
FormItem.bind string Binding string form special fields. Values:
  • crm-name
  • crm-address
  • crm-address-firstline
  • crm-address-secondline
  • crm-address-city
  • crm-address-postalcode
  • crm-address-state
  • crm-address-country
  • crm-job-title
  • crm-company
  • crm-notifications
  • crm-language
  • crm-reference
  • crm-reminder
  • crm-birthdate
  • crm-miscellaneous-* : CRM additional fields (from 1 to 10)
Some other values are available but can only be set in the contactFields field :
  • crm-first-name
  • crm-last-name
  • crm-email
  • crm-phone
FormItem.bindGroup string Binding group string form special group of fields. Values:
  • crm
FormItem.externalId string External identifier of this field. When this value is set up, this field would be fulfilled by HTTP query parameters on the appointment widget.
FormItem.help string Help text of the field.
FormItem.mandatory boolean If the field is mandatory.
FormItem.visible boolean If the field is visible by client.
FormItem.otherValue boolean Activate or deactivate the possibility to add a custom value to the field. Available for type radio, checkbox and select.
FormItem.category boolean Activate or deactivate the possibility to group values by category. Available only for type select.
FormItem.multiple boolean Activate or deactivate the possibility to select several values. Available only for type select.
FormItem.value string Value of the field. With file type : get and list methods will return the link to the file, for insert and update methods it is the data URI scheme binary content of the file.
FormItem.fileName string (Optional) When the value is a file, a fileName can be specified. If not specified, the file will be named "file" and get the extension from the media type
FormItem.values list Values list of the field. Available for type radio, checkbox and select.
FormItem.values[].id string Identifier of the field value.
FormItem.values[].name string Name of the field value.
FormItem.values[].value string Identifier of the field value.
FormItem.values[].values list List of values of the form field value. Available only for type select with option category set to True
FormItem.values[].values[].id string Identifier of the form field value. Available only for type select with option category set to True
FormItem.values[].values[].name string Name of the form field value. Available only for type select with option category set to True
FormItem.values[].values[].value string Value of the form field value. Available only for type select with option category set to True
FormItem.valueFormat object Input rules.
FormItem.valueFormat.maxLength number Value maximum length.
FormItem.valueFormat.minLength number Value minimum length.
FormItem.valueFormat.regexType string Type of regex.
FormItem.valueFormat.regexValue string Value of regex.
FormItem.valueFormat.valueFormat string Type or format
  • alphanumeric
  • numeric
  • regex
  • none
FormItem.zonedDateTime object If the field is a date type, the value is formatted and returned with his timezone Read only
FormItem.zonedDateTime.dateTime object The value of the field formatted. For example '2011-12-03T10:15:30' Read only
FormItem.zonedDateTime.timeZone object The date timezone. For example 'Europe/Paris' Read only
FormItem.subItem list List of sub FormItem, available for crm-address field and crm-name field.

Delete

Deletes an entry on the form list.

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.3/forms/{formId}

Parameters

Parameter name Value Description
Path parameters
formId string Form 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 form list.

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

Request

HTTP Request

GET https://api.agendize.com/api/2.3/forms/{formId}

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.

Request body

Do not supply a request body with this method.

Response

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


List

Returns entries on the form list.

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

Request

HTTP Request

GET https://api.agendize.com/api/2.3/forms

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

Insert

Adds an entry to the form list.

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

Request

HTTP Request

POST https://api.agendize.com/api/2.3/forms

Request body

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

Parameter name Value Description
Required Properties
name string Name of the form.
Optional Properties
id string Identifier of the form.
author string Author of the form.
description string Description of the form.
content string Content of the form in XML.
submitMessage string Message of the form after validation.
fields[] list Fields of the form.

Response

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


Update

Updates an entry on the form list.

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.3/forms/{formId}

Parameters

Parameter name Value Description
Path parameters
formId string Form identifier.

Request body

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

Parameter name Value Description
Optional Properties
name string Name of the form.

Response

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