Skip to main content

Choice Group

A group of related choices

idstringrequired

Unique group identifier

groupLabelstring

Label for the choice group

choices object[]required

Choices within this group

Possible values: <= 1000

  • Array [
  • idstringrequired

    Unique choice identifier

    Example: 1
    displaystringrequired

    Choice text/HTML to display

    image object

    Image associated with the choice

    namestringrequired

    Image filename

    urlstringrequired

    Image URL

    textPositionstringrequired

    Position of text relative to image

    Possible values: [top, left, right, bottom]

    expandedUrlstring

    URL for expanded/full-size image

    textEntry object

    Text entry field associated with this choice

    contentTypestring

    Expected content type

    Possible values: [number, date, integer]

    requiredboolean

    Whether text entry is required when choice is selected

    Possible values: [true]

    symbol object

    Symbol/prefix for text entry fields

    valuestringrequired

    Symbol to display (e.g., '$', '%')

    Example: $
    positionstringrequired

    Position of symbol relative to input

    Possible values: [before, after]

    exclusiveSelectboolean

    Whether selecting this choice deselects all others

    Possible values: [true]

  • ]
  • Choice Group
    {
    "id": "string",
    "groupLabel": "string",
    "choices": [
    {
    "id": "1",
    "display": "string",
    "image": {
    "name": "string",
    "url": "string",
    "textPosition": "top",
    "expandedUrl": "string"
    },
    "textEntry": {
    "contentType": "number",
    "required": true,
    "symbol": {
    "value": "$",
    "position": "before"
    }
    },
    "exclusiveSelect": true
    }
    ]
    }