Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Field permissions

Update permissions for writing field values and form visibility for a specific field. This endpoint is used to restrict the ability to modify field values to the roles defined. It also makes it possible to decide if the field can be exposed in forms or not.

This is a enterprise feature.

patch/api/field-permissions/{field_id}/

Path parameters

field_idinteger required

The ID of the field to update the permissions for.

Request body

role'ADMIN' | 'BUILDER' | 'EDITOR' | 'NOBODY'
  • ADMIN - Admin
  • BUILDER - Builder
  • EDITOR - Editor
  • NOBODY - Nobody
allow_in_formsboolean

Whether to allow this field to be shown in forms. Default is False. This setting is only relevant if the role is not 'EDITOR'.

Response

role'ADMIN' | 'BUILDER' | 'EDITOR' | 'NOBODY' required
  • ADMIN - Admin
  • BUILDER - Builder
  • EDITOR - Editor
  • NOBODY - Nobody
allow_in_formsboolean

Whether to allow this field to be shown in forms. Default is False. This setting is only relevant if the role is not 'EDITOR'.

field_idinteger required

The ID of the field whose permissions were updated.

can_write_valuesboolean

Whether the user can write values to this field.