Configure the form entry element response API in FireForm

On this page:

Overview
Configuration
Expected input parameters
Return values
Example
Get help

Overview

You can update a single element response in a FireForm form entry with the Form Entry Response (Put) API. The relevant form elements must have an integration status. Also, when using this API:

Validations are applied for currency, integer, and decimal data types.
Min/max validations are applied where applicable.
The data type Text (short) has a 200-character maximum length.

Note:

To request API access for your FireForm tenant, submit a FireForm API Access Request.

Configuration

To configure this API, see /api/v1/forms/entry/response on the FireForm API page.

Expected input parameters

Parameter	Description	Format	Required (Y/N)
FormCode	The form's unique identifier	Alphanumeric (15 characters max)	Y
EntryshortId	The form entry's unique identification number	Integer	Y
IDNumber	The form element's unique identification number	Integer	Y
Response	The desired response for the element	Depends on element data type	Y

Return values

Expected return data

No content is returned if successful.

Other return values

Code	Description
400	Item is null or values are invalid
404	Item not found

Example

Example input

{
 "FormCode": "demo",
 "EntryShortId": 4038,
 "IdNumber": 3,
 "Response": "5"
}

Example return