Add or Update Values for List Fields

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

This resource accepts one or more options. To update an option, specify an ID. You may also remove an option from the list of current values by archiving the value. To create a new option, do not specify an "id" attribute.

Sample Request

{
    "options": [
                    {
                        "value": "New Value"
                    },
                    {
                        "id": 11412,
                        "archived": "yes",
                        "value": "Updated Value"
                    }
    ]
}

Responses

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.bamboohr.com/api/gateway.php/companyDomain/v1/meta/lists/listFieldId \
3
     --header 'accept: application/xml' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here!

200A successful response indicates that all the requested changes were made. The content of the response will be the full list of options for the specified listId.

400The posted JSON is invalid.

403List is not editable or insufficient permissions.

404A non-existant list value or option ID is specified.

409A duplicate list value conflicted with the value specified.