Fields

APIs REST Version 1

Field Information

The Field Information route retreives schema information for a field. The information returned includes the fields's name, and configurations.

The permalink parameter should be the form's 10-character permalink as it appears in URLs like /forms/XXXXXXXXXX/responses. The variable_name parameter should be the variable name assigned to the field. The brackets are included to highlight the parameters, and should not be included in the actual URL.

GET https://forms.sonadier.com/api/v1/forms/[permalink]/fields/[variable_name]

Update a Field's Options

The Field Update route lets you change a field's options. The updated information should be passed with the request's body, and use the same format for options returned by the Field Information route.

The permalink parameter should be the form's 10-character permalink as it appears in URLs like /forms/XXXXXXXXXX/responses. The variable_name parameter should be the variable name assigned to the field. The brackets are included to highlight the parameters, and should not be included in the actual URL.

POST https://forms.sonadier.com/api/v1/forms/[permalink]/fields/[column_name]
Data: {
  name: "New Field Name"
}