ROrocketlane
Fields

Update field Option

Update an option on a SINGLE_CHOICE or MULTIPLE_CHOICE field, or a tag on a NOTE field. For NOTE fields, tags are exposed and updated via fieldOptions.

post/1.0/fields/{fieldId}/update-option

Request

Path parameters

fieldIdinteger required

The field's unique, system-generated identifier, which can be used to identify the field globally.

Request body

optionValueinteger required

The optionValue is the unique identifier for the option (or tag, for NOTE fields).

optionColor'RED' | 'YELLOW' | 'GREEN' | 'TEAL' | 'CYAN' | 'BLUE' | 'PURPLE' | 'MAGENTA' | 'GRAY' | 'COOL_GRAY'

The optionColor reflects the color of the option for single/multiple choice fields, or the tag color for NOTE fields.

optionLabelstring

The optionLabel reflects the name of the option for single/multiple choice fields, or the tag label for NOTE fields.

Example request

{
  "optionValue": 3,
  "optionColor": "RED",
  "optionLabel": "High"
}

Response

The requested action was successfully executed.

optionValueinteger

The optionValue is the unique identifier for the option (or tag, for NOTE fields).

optionLabelstring

The optionLabel reflects the name of the option for single/multiple choice fields, or the tag label for NOTE fields.

optionColor'RED' | 'YELLOW' | 'GREEN' | 'TEAL' | 'CYAN' | 'BLUE' | 'PURPLE' | 'MAGENTA' | 'GRAY' | 'COOL_GRAY'

The optionColor reflects the color of the option for single/multiple choice fields, or the tag color for NOTE fields.

Example response

{
  "optionValue": 2,
  "optionLabel": "Todo",
  "optionColor": "RED"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.