addRecord()

Last updated 10/03/2026

Definition

addRecord()

is a function on the

Five

object that adds a record to the current internal form transaction in the frontend. The record is stored in the transaction and prepared to be saved to the database when the user clicks the Save button on the form, or when the

saveRecords()

function is called through the Five API. This function effectively allows records to be programmatically added to the form's save process, similar to how records are handled when using Five's forms.

Available: Client and server

Function Signature

addRecord(actionKey: string, record: FiveRecord) : boolean;

Parameter	Type	Description
actionKey	string	The action key identifying the form action that the record should be associated with
record	FiveRecord	The FiveRecord object containing the data to be added to the internal form transaction

Return Value

A boolean value indicating whether the record was successfuly added to the transaction.

Examples

addRecord()