Custom field options API

Update a custom field option

PUT /api/v1/custom_field_definitions/:custom_field_definition_id/custom_field_options/:id

Parameters
NameDescription
custom_field_definition_id *

Numeric ID of the custom field

value

The value of the custom field option

color

Base 10 representation of a hex rgb color. E.g. #666666 is 6710886

hidden

Boolean flag indicating if the option should be hidden

Example request

PUT /api/v1/custom_field_definitions/581360680/custom_field_options/486420793

Example CURL command

curl "https://company.aha.io/api/v1/custom_field_definitions/581360680/custom_field_options/486420793" -d '{"custom_field_option":{"value":"New option2"}}' -X PUT \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
contentType: application/json
accept: application/json

Request body

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body