Update custom field option

PATCH /api/v3/custom_field_options/{id}

Request

Response

URL

PATCH https://example.aha.io/api/v3/custom_field_options/123

JSON body

{
  "record": {}
}

cURL command

curl --request PATCH 'https://example.aha.io/api/v3/custom_field_options/123' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "record": {}
}'

Request conventions

API key or OAuth2 access token. See Authentication.

Use your account domain and token in copied requests. Request values and conditional fields must satisfy your account’s validation rules.

URL settings

Account subdomain

The part before .aha.io. Leave blank to use the example domain.

ID of the custom field option

Request fields

Send only the fields you want to change inside a JSON record object. This applies to both PUT and PATCH.

Only writable fields for this endpoint are listed. Required flags reflect the endpoint schema; record and workspace validation also applies.

Search request fields

Field	Type	Response field
Name of the option.	string	`name`
Include name in request Accepted value shape and constraints Type: `string`
Color of the option as a hex value.	string	`color`
Include color in request Accepted value shape and constraints Type: `string`
Whether the option is hidden from selection. Hidden options remain on records that already use them.	boolean	`hidden`
Include hidden in request Accepted value shape and constraints Type: `boolean`
Position of the option among its siblings. Options of conditional choice fields are ordered under their parent.	integer	`position`
Include position in request Accepted value shape and constraints Type: `integer`
ID of the parent option of a conditional choice field option; set on create only and null for other options.	string	`parent_id`
Include parent_id in request Accepted value shape and constraints Type: `string`

Response fields

Choose which fields to include in the response. Expand a field for examples and associated fields. Collections can only be returned on the top-level resource, not inside an associated resource.

Default response fields are returned until you select specific fields.

Search fields

Field	Type	Returned by default
Unique record ID.	integer	Yes
Include id in response
Choice custom field definition that owns the option.	CustomFieldDefinition	No
Include custom_field_definition in response Expand this association to browse its response fields.
Name of the option.	string	Yes
Include name in response
Color of the option as a hex value.	string	No
Include color in response
Whether the option is hidden from selection. Hidden options remain on records that already use them.	boolean	No
Include hidden in response
Position of the option among its siblings. Options of conditional choice fields are ordered under their parent.	integer	No
Include position in response
Parent option of a conditional choice field option; set on create only and null for other options.	string	No
Include parent_id in response
Date and time when the record was created.	date-time	No
Include created_at in response
Date and time when the record was last updated.	date-time	No
Include updated_at in response

Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.

Response field selection

Create and update responses also include fields submitted in the record body. Submitted association IDs return their associated response fields.

Return selected fields with a comma-separated fields parameter, or add a field to the defaults with fields=default,{field}. Expand an association above for its supported subfields and selection examples.

See field selection for details.

Response statuses

Error shape for 400, 401, 403, 404, 409

Type: object

error

Type: object

Required properties: status, code, message, request_id.

status

Type: integer

code

Type: string

message

Type: string

request_id

Type: string

Error shape for 422

Type: object

error

Type: object

Required properties: status, code, message, details, request_id.

status

Type: integer

Allowed values: 422

code

Type: string

Allowed values: "record.validation_failed", "record.cannot_delete"

message

Type: string

details

Type: array

Array item shape

Type: object

field

Type: string

message

Type: string

code

Type: string

request_id

Type: string

Response envelope and pagination

record: a single record. Fields are documented above.

Download the complete OpenAPI specification