Update Collection Field

PATCH

Update a custom field in a collection.

Required scope | cms:write

Path parameters

collection_idstringRequired

Unique identifier for a Collection

field_idstringRequired

Unique identifier for a Field in a collection

Request

This endpoint expects an object.
isRequiredbooleanOptionalDefaults to false

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

idstring

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

isEditablebooleanOptionalDefaults to false

Define whether the field is editable

slugstringOptional

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

helpTextstringOptional

Additional text to help anyone filling out this field

Errors