Single Option Radio
The Single Option Radio Answer is used to submit a single selection from a set of radio button options defined in the form.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
fieldTypeId | string | Yes | Must be set to SingleOptionRadio |
optionId | string | Yes | The ID of the selected option from the form's predefined options |
Example Usage
Given a form field with these options:
{
"id": "8d16fb84-fb22-4bf7-ad94-748ccd798596",
"name": "Marital status",
"fieldTypeId": "SingleOptionRadio",
"options": [
{ "id": "25fa717f-e40c-443c-8897-0237df9bf788", "optionText": "Single", "optionValue": "1" },
{ "id": "1bf05680-dc57-4859-8223-842a8d488c6e", "optionText": "Married", "optionValue": "2" },
{ "id": "121fb9fd-4087-4423-b94a-f54aa149c10e", "optionText": "Widowed", "optionValue": "3" },
{ "id": "41467ec6-5e0b-400b-ab0e-1e876ef989c9", "optionText": "Divorced", "optionValue": "4" }
]
}
Submit the answer like this:
{
"fieldId": "8d16fb84-fb22-4bf7-ad94-748ccd798596",
"answer": {
"fieldTypeId": "SingleOptionRadio",
"optionId": "1bf05680-dc57-4859-8223-842a8d488c6e"
}
}
Notes
- The
optionIdmust match one of the option IDs defined in the form field. - Only one option can be selected at a time.
- Use this field type for mutually exclusive choices like gender, marital status, or yes/no questions.
- The available options are defined in the form structure and can be retrieved via the Get Form Fields endpoint.