API documentation

Params

Param name	Description Validations
offer_id Optional	Assign the record to this Offer. Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
key Optional	The internal token name where values are stored. Validations: Must be a String
required Optional Blank Value Allowed	Is this field required? Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off
name Optional Blank Value Allowed	The friendly human name displayed to users. Validations: Must be a String
hint Optional Blank Value Allowed	Display a helpful hint to users explaining the purpose of this field. Validations: Must be a String
value_type Optional Blank Value Allowed	Field Type Validations: Must be one of: `string`, `decimal`, `integer`, `time`, `boolean`, `expression`, `hidden`.
decimal_places Optional Blank Value Allowed	Decimal values/expressions will be rounded to this many decimal places. Validations: Must be a decimal number.
value_formatter Optional Blank Value Allowed	Expression Formatter Validations: Must be one of: `string`, `decimal`, `integer`, `time`, `boolean`.
value_expression Optional Blank Value Allowed	Expression Validations: Must be a String
sortable_order Optional Blank Value Allowed	The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first. Validations: Must be a decimal number.