CMSCollection Fields

Update Collection Field

Update a custom field in a collection.

Required scope | cms:write

Path parameters

collection_idstringRequiredformat: "objectid"
Unique identifier for a Collection
field_idstringRequiredformat: "objectid"
Unique identifier for a Field in a collection

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The field details to update
isRequiredbooleanOptional
Define whether a field is required in a collection
displayNamestringOptional
The name of a field
helpTextstringOptional
Additional text to help anyone filling out this field

Response

Request was successful
idstringformat: "objectid"
Unique identifier for a Field
isRequiredboolean
define whether a field is required in a collection
typeenum
Choose these appropriate field type for your collection data
displayNamestring
The name of a field
isEditableboolean or null
Define whether the field is editable
slugstring or null

Slug of Field in Site URL structure. Slugs should be all lowercase with no spaces. Any spaces will be converted to ”-.”

helpTextstring or null
Additional text to help anyone filling out this field

Errors