CMSCollection Fields

Update field

Update a custom field in a collection.

Required scope | cms:write

Authentication

AuthorizationBearer

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

Path parameters

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

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
isEditablebooleanRead-only
Define whether the field is editable
slugstring

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

helpTextstring
Additional text to help anyone filling out this field
validationsobject or nullRead-only
The validations for the field

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error