Skip to content

Create a field option

Request

Create a new FieldOption resource adding it to the set of valid choices for an Field where Field.hasFixedOptions = true.

Security
bearerToken
Bodyapplication/jsonrequired
fieldIdstringrequired

The unique ID of the Field the FieldOption should belong to

Example:"a52b5315-15b8-417f-b742-d6902108bac1"
valuestringrequired

The human-readable value of the FieldOption

Example:"Folder A"
positioninteger

The 0-based position the FieldOption should occupy relative to the other options

Default:0
Example:2
parentIdstring or null

The FieldOption.id of the option above this one in the hierarchy

Default:null
curl -i -X POST \
  https://api-v2.dash.app/field-options \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fieldId": "a52b5315-15b8-417f-b742-d6902108bac1",
    "value": "My Top Level Folder",
    "position": 3,
    "parentId": null
  }'

Responses

Success

Bodyapplication/json
resultobjectrequired
permittedActionsArray of objectsrequired

Permitted actions for FieldOption resources:

Response
{ "result": { "id": "1fc6d6c3-c42d-48e2-b0db-5d680a58ca52", "fieldId": "a52b5315-15b8-417f-b742-d6902108bac1", "value": "My Top Level Folder", "position": 0, "leaf": false, "parent": null }, "permittedActions": [] }