Fields

code : String! required

The code of the field.
deprecated : Boolean! required

Whether the field is deprecated.
Deprecation
The 'deprecated' field is deprecated.

Fields are not being deprecated

- Marked as deprecated on 2026-04-20.
- Scheduled for removal on or after 2026-05-20.
fieldType : FieldTypeChoices! required

The type of the field.
name : String! required

The name of the field.
orderInCollection : Int

The order of the field in the collection.
required : Boolean

Whether the field is required.
textChoices : [String]

The choices for the field if applicable.
textRegex : String

A regular expression that a field value must match, if populated.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "code": "purpose-study-usually-gas-think", "fieldType": "STR", "name": "reach-machine-world-doctor-rise", "orderInCollection": 11, "required": true, "textChoices": "card-coach-Mrs-environmental-forward", "textRegex": "media-effort-fund-box-dog" }