Multi Options Checkbox

The Multi Options Checkbox Answer is used to submit multiple selections from a set of checkbox options defined in the form.

Fields

Field	Type	Required	Description
fieldTypeId	string	Yes	Must be set to MultiOptionsCheckBox
optionIds	string[]	Yes	An array of selected option IDs from the form's predefined options

Example Usage

Given a form field with these options:

{
  "id": "4e594876-ba36-438b-8c6b-4da0804c64a2",
  "name": "Income Sources",
  "fieldTypeId": "MultiOptionsCheckBox",
  "options": [
    { "id": "1d90c851-2f6a-4e8a-8d2c-2fafa6b51487", "optionText": "Salary", "optionValue": "1" },
    { "id": "c5e14b9e-b89d-4a16-9be9-e4acaf8fed02", "optionText": "Savings", "optionValue": "2" },
    { "id": "1f8b26f1-2e62-4a8c-96e9-09e7d524902e", "optionText": "Family", "optionValue": "3" },
    { "id": "72145264-080c-4bc4-8351-127231c34902", "optionText": "Investment", "optionValue": "4" },
    { "id": "042d7309-df72-4d99-8fd0-c4883a5cf180", "optionText": "Trading", "optionValue": "5" },
    { "id": "989756b3-9e61-49f2-a832-a2bbe195c4d4", "optionText": "Real Estate", "optionValue": "7" },
    { "id": "58b32715-54cc-457a-9905-402951a13e0e", "optionText": "Other", "optionValue": "8" }
  ]
}

Submit the answer with multiple selections:

{
  "fieldId": "4e594876-ba36-438b-8c6b-4da0804c64a2",
  "answer": {
    "fieldTypeId": "MultiOptionsCheckBox",
    "optionIds": [
      "1d90c851-2f6a-4e8a-8d2c-2fafa6b51487",
      "c5e14b9e-b89d-4a16-9be9-e4acaf8fed02",
      "72145264-080c-4bc4-8351-127231c34902"
    ]
  }
}

Notes

• Each optionId in the array must match one of the option IDs defined in the form field.
• Multiple options can be selected simultaneously.
• Use this field type for non-exclusive choices like income sources, investment types, or feature preferences.
• The available options are defined in the form structure and can be retrieved via the Get Form Fields endpoint.
• To select no options, pass an empty array: "optionIds": []