Params

Param name
Description
offer_id
Required

Assign the record to this Offer.

key
Required

The internal token name where values are stored.

  • Must be String

required
Optional Blank Value Allowed

Is this field required?

  • 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.

  • Must be String

hint
Optional Blank Value Allowed

Display a helpful hint to users explaining the purpose of this field.

  • Must be String

value_type
Optional Blank Value Allowed

Field Type

  • 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.

  • Must be a decimal number.

value_formatter
Optional Blank Value Allowed

Expression Formatter

  • Must be one of: string, decimal, integer, time, boolean.

value_expression
Optional Blank Value Allowed

Expression

  • Must be 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.

  • Must be a decimal number.