Create field

post

https://testflight.tremendous.com/api/v2/fields

Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes.

Body Params

Field details

display_name

string

required

A human-readable name for the field. Can contain letters, numbers, spaces, and underscores.
The field's label (a reference name used in API requests) will be automatically derived from this value.

data_type

string

enum

required

Type of the values of the field

Type	Description
`Checkbox`	A boolean value (true/false)
`Currency`	A monetary value
`Date`	A date value
`Dropdown`	A single selection from predefined options (see `data.options`)
`Email`	An email address
`List`	Multiple selections from predefined options (see `data.options`)
`Number`	A numeric value
`Phone`	A phone number
`Text`	A single-line text value
`TextArea`	A multi-line text value

data

object

Additional configuration for the field. Required for Dropdown and List data types.

required

boolean

Defaults to false

Is this field required (true) or optional (false). Defaults to false.

description

string

A description of the field's purpose

Responses

200Created field

401Authorization error, for example due to an invalid or missing API key, or because the API key is restricted to a different source IP address.

422Validation error of the sent parameters or request body

429Rate limit exceeded, this request was not processed. Future requests may not be processed until your account drops below the rate limit threshold

500The server encountered an unexpected error or couldn't fulfill the request in time.