v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Account Information

Public API

Update List Field Values

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.

OAuth Scopes: field.write

put/api/v1/meta/lists/{listFieldId}

Path parameters

listFieldIdstring required

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

Query parameters

format'json'

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

Request body

Response

All requested changes were applied. Returns the full updated list.

idinteger

The list ID.

fieldIdinteger

The field ID.

namestring

The display name of the list field.

aliasstring nullable

The API alias for the list field.

manageable'yes' | 'no'

Whether the list field options can be modified via the API.

multiple'yes' | 'no'

Whether this field supports multiple values.