Gender
The Gender Answer is used to submit a person's gender for a field of type Gender.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
fieldTypeId | string | Yes | Must be set to Gender (from FieldTypeEnum) |
gender | string | Yes | The gender value: Male or Female |
Example Usage
Given a form field like this from Get Form Fields:
{
"fieldId": "7d4e2b19-5c3a-4f86-9e21-0b8c6a4f3d57",
"fieldType": "Gender",
"fieldName": "Gender",
"sectionName": "Personal Information",
"pageName": "Customer Details",
"pageId": "a56e3cbc-b6d3-4d49-881b-33d2c497adaf",
"isRequired": true
}
Submit the answer like this:
{
"fieldId": "7d4e2b19-5c3a-4f86-9e21-0b8c6a4f3d57",
"answer": {
"fieldTypeId": "Gender",
"gender": "Female"
}
}
Notes
- Values are case-sensitive: send
MaleorFemaleexactly. Any other value (for examplemaleorF) is rejected withCan't find value '<value>'. - The values are fixed, so a Gender field has no
optionsarray and no option IDs. Do not send anoptionId. - Check the field's
fieldTypein Get Form Fields before submitting. A gender question can also be configured as a Single Option Select or Single Option Radio field, which are answered with anoptionIdinstead. - Get Submission returns the answer as
{ "gender": "Female" }.