DocumentationAPI Reference
API Reference

Update List Field Values

put
https://{companyDomain}.bamboohr.com/api/v1/meta/lists/

Create, update, or archive options for a list field. To update an existing option, specify its id. To create a new option, omit id. To archive an option, set archived to yes — the option is soft-deleted and will continue to appear in GET responses for historical data integrity. To reactivate an archived option, set archived to no. The archivedDate field is server-set when an option is first archived and is not cleared if the option is later reactivated. Options on list fields with manageable: no cannot be modified and will return a 405.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The field ID of the list to update. This is the fieldId value returned by the GET endpoint, not the list id.

Query Params
string
enum

Set to "json" to receive JSON output as an alternative to using the Accept header.

Allowed:
Body Params

Payload for creating, updating, or archiving options on a list field.

options
array of objects

The list field options to create, update, or archive.

options
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

The request body is invalid or malformed.

403

The list is not editable, or the API user does not have sufficient permissions.

404

The specified list field or option ID does not exist.

405

One or more of the specified options belong to a non-manageable list field and cannot be modified.

409

A duplicate list value conflicted with the value specified.

Updated about 1 month ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago