---
title: "Add options to a custom field"
method: POST
path: "/v0/custom_fields/{custom_field_id}/options"
tags: ["Custom Field Options"]
---

# Add options to a custom field

`POST /v0/custom_fields/{custom_field_id}/options`

## Request

- Base URL: `https://api.gem.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gem.com/v0/custom_fields/{custom_field_id}/options`
- Auth: none declared

Returns the newly created options in a `single_select` or `multi_select`
custom field.

De-duplication: If options with the values already existed,
a 400 error will be returned in the following format.
```
{
    "code": 400,
    "errors": {
        "json": {
            "options": [
                {
                    "id": "example_option_id",
                    "is_hidden": false,
                    "value": "example_value"
                }
            ]
        }
    },
    "message": "Custom field options with the values already existed.",
    "status": "Bad Request"
}
```

## Request body

- CustomFieldOptionCreation
  - `option_values` string[], required: An array of new option values to be created. Any leading and trailing spaces of the new option values will be removed.

## Response `201`

Created

- CustomFieldOption[]
  - `id` string, ObjectID
  - `value` string
  - `is_hidden` boolean: `hidden` options are not selectable in the Gem product. Candidate custom field values with `hidden` options are not returned when making a query to the Candidates endpoint.

## Other responses

- `422`: Unprocessable Content
- `default`: Default error response

---

[API](https://skmtc.dev/gem/apis/gem-crm-api.md) - [All operations](https://skmtc.dev/gem/apis/gem-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gem/apis/gem-crm-api/revisions/50a984e3c2b5?raw)